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(void* ptr, size_t size, size_t nmemb,
83 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb,
85 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path);
86 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
87 XBT_PUBLIC(size_t) MSG_file_get_size(msg_file_t fd);
89 XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
90 XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
92 /************************** AS Router handling ************************************/
93 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
94 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
95 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
97 /************************** Host handling ***********************************/
98 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
99 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
100 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
101 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
102 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
103 /* int MSG_get_msgload(void); This function lacks specification; discard it */
104 XBT_PUBLIC(double) MSG_get_host_speed(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 /*property handlers*/
109 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
110 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
112 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
113 const char *name, char *value,
114 void_f_pvoid_t free_ctn);
117 XBT_PUBLIC(void) MSG_create_environment(const char *file);
119 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
120 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
121 XBT_PUBLIC(int) MSG_get_host_number(void);
123 /************************** Process handling *********************************/
124 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
125 xbt_main_func_t code,
126 void *data, msg_host_t host);
127 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
133 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
143 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
144 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
146 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
148 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
149 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
151 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
152 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
153 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
154 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
155 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
156 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
157 XBT_PUBLIC(int) MSG_process_self_PID(void);
158 XBT_PUBLIC(int) MSG_process_self_PPID(void);
159 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
160 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
161 XBT_PUBLIC(int) MSG_process_get_number(void);
163 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
165 /*property handlers*/
166 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
167 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
171 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
172 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
173 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
174 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
175 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
177 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
179 /************************** Task handling ************************************/
180 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
181 double compute_duration,
182 double message_size, void *data);
183 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
184 double compute_duration,
185 double dispatch_latency,
186 double collect_latency);
187 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
189 const msg_host_t * host_list,
190 double *computation_amount,
191 double *communication_amount,
193 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
194 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
195 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
196 msg_task_t task, msg_process_t src, msg_process_t dst));
197 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
198 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
199 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
200 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
201 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
202 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
204 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
206 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
207 msg_host_t host, double rate);
209 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
210 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
211 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
213 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
215 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
216 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
217 double compute_duration);
218 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
221 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
222 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
223 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
224 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
227 XBT_PUBLIC(msg_error_t)
228 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
231 XBT_PUBLIC(msg_error_t)
232 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
235 XBT_PUBLIC(msg_error_t)
236 MSG_task_receive(msg_task_t * task, const char *alias);
237 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
241 XBT_PUBLIC(msg_error_t)
242 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
243 msg_host_t host, double rate);
245 XBT_PUBLIC(msg_error_t)
246 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
247 double timeout, double rate);
249 XBT_PUBLIC(msg_error_t)
250 MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
251 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
253 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
254 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
255 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
257 int (*match_fun)(void*,void*, smx_action_t),
260 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
261 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
262 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
263 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
264 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
265 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
266 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
267 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
268 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
270 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
271 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
272 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
274 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
276 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
279 XBT_PUBLIC(msg_error_t)
280 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
283 XBT_PUBLIC(msg_error_t)
284 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
285 double timeout, double maxrate);
287 XBT_PUBLIC(msg_error_t)
288 MSG_task_send(msg_task_t task, const char *alias);
290 XBT_PUBLIC(msg_error_t)
291 MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
293 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
295 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
296 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
298 /************************** Task handling ************************************/
299 XBT_PUBLIC(msg_error_t)
300 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
301 msg_host_t host, double timeout);
303 XBT_PUBLIC(msg_error_t)
304 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
305 msg_host_t host, double timeout, double rate);
307 XBT_PUBLIC(msg_error_t)
308 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
311 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
314 /************************** Action handling **********************************/
315 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
317 #ifdef MSG_USE_DEPRECATED
319 typedef msg_error_t MSG_error_t;
321 #define MSG_global_init(argc, argv) MSG_init(argc,argv)
322 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
324 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
325 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
327 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
328 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
329 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
330 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
332 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
333 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
335 XBT_PUBLIC(msg_error_t) MSG_clean(void);
337 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
338 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
340 double max_duration);
341 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
342 int channel, msg_host_t host);
343 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
346 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
347 m_channel_t channel);
348 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
352 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
355 double max_duration);
356 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
357 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
358 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
360 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
361 XBT_PUBLIC(int) MSG_get_channel_number(void);
364 /** @brief Opaque type representing a semaphore
365 * @ingroup msg_synchro
368 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
369 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
370 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
371 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
372 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
373 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
374 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
375 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
377 /** @brief Opaque type describing a Virtual Machine.
380 * All this is highly experimental and the interface will probably change in the future.
381 * Please don't depend on this yet (although testing is welcomed if you feel so).
382 * Usual lack of guaranty of any kind applies here, and is even increased.
385 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
386 XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, const char *name, int coreAmount);
388 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
389 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
391 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, msg_process_t process);
392 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, msg_process_t process); // simple wrapper over process_kill
394 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
396 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
397 // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
399 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm); // Simulate the fact of reading the processes from disk and resuming them
400 // \forall p in VM, MSG_process_resume(p) // unfreeze them
402 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
404 XBT_PUBLIC(void) MSG_vm_reboot(msg_vm_t vm);
406 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
408 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
411 void* MSG_process_get_property(msg_process_t, char* key)
412 void MSG_process_set_property(msg_process_t, char* key, void* data)
413 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
415 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
416 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
417 // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
418 // <100 si c'est pas CPU intensive)
419 // Contraintes à poser:
420 // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
421 // VM_coreAmount >= Load de toutes les tasks
425 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
426 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
427 + des fonctions de filtrage sur les dynar
429 #include "instr/instr.h"
433 /* ****************************************************************************************** */
434 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
435 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
437 /* ****************************************************************************************** */
438 /* TUTORIAL: New API */
439 /* Declare all functions for the API */
440 /* ****************************************************************************************** */
441 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);