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);
73 /************************** File handling ***********************************/
74 XBT_PUBLIC(double) MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t stream);
75 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
76 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode);
77 XBT_PUBLIC(int) MSG_file_close(msg_file_t fp);
78 XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf);
79 XBT_PUBLIC(void) MSG_file_free_stat(s_msg_stat_t *stat);
81 XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
82 XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
84 /************************** AS Router handling ************************************/
85 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
86 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
87 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
89 /************************** Host handling ***********************************/
90 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
91 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
92 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
93 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
94 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
95 /* int MSG_get_msgload(void); This function lacks specification; discard it */
96 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
97 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
98 XBT_PUBLIC(void) __MSG_host_priv_free(msg_host_priv_t priv);
99 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
101 /*property handlers*/
102 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
103 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
105 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
106 const char *name, char *value,
107 void_f_pvoid_t free_ctn);
110 XBT_PUBLIC(void) MSG_create_environment(const char *file);
112 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
113 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
114 XBT_PUBLIC(int) MSG_get_host_number(void);
116 /************************** Process handling *********************************/
117 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
118 xbt_main_func_t code,
119 void *data, msg_host_t host);
120 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
126 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
136 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
137 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
139 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
141 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
142 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
144 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
145 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
146 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
147 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
148 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
149 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
150 XBT_PUBLIC(int) MSG_process_self_PID(void);
151 XBT_PUBLIC(int) MSG_process_self_PPID(void);
152 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
153 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
154 XBT_PUBLIC(int) MSG_process_get_number(void);
156 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
158 /*property handlers*/
159 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
160 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
164 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
165 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
166 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
167 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
168 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
170 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
172 /************************** Task handling ************************************/
173 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
174 double compute_duration,
175 double message_size, void *data);
176 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
177 double compute_duration,
178 double dispatch_latency,
179 double collect_latency);
180 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
182 const msg_host_t * host_list,
183 double *computation_amount,
184 double *communication_amount,
186 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
187 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
188 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
189 msg_task_t task, msg_process_t src, msg_process_t dst));
190 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
191 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
192 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
193 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
194 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
195 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
197 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
199 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
200 msg_host_t host, double rate);
202 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
203 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
204 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
206 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
208 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
209 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
210 double compute_duration);
211 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
214 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
215 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
216 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
217 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
220 XBT_PUBLIC(msg_error_t)
221 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
224 XBT_PUBLIC(msg_error_t)
225 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
228 XBT_PUBLIC(msg_error_t)
229 MSG_task_receive(msg_task_t * task, const char *alias);
230 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
234 XBT_PUBLIC(msg_error_t)
235 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
236 msg_host_t host, double rate);
238 XBT_PUBLIC(msg_error_t)
239 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
240 double timeout, double rate);
242 XBT_PUBLIC(msg_error_t)
243 MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
244 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
246 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
247 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
248 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
250 int (*match_fun)(void*,void*, smx_action_t),
253 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
254 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
255 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
256 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
257 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
258 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
259 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
260 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
261 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
263 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
264 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
265 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
267 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
269 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
272 XBT_PUBLIC(msg_error_t)
273 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
276 XBT_PUBLIC(msg_error_t)
277 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
278 double timeout, double maxrate);
280 XBT_PUBLIC(msg_error_t)
281 MSG_task_send(msg_task_t task, const char *alias);
283 XBT_PUBLIC(msg_error_t)
284 MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
286 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
288 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
289 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
291 /************************** Task handling ************************************/
292 XBT_PUBLIC(msg_error_t)
293 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
294 msg_host_t host, double timeout);
296 XBT_PUBLIC(msg_error_t)
297 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
298 msg_host_t host, double timeout, double rate);
300 XBT_PUBLIC(msg_error_t)
301 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
304 void MSG_mailbox_set_async(const char *alias);
307 /************************** Action handling **********************************/
308 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
310 #ifdef MSG_USE_DEPRECATED
312 typedef msg_error_t MSG_error_t;
314 #define MSG_global_init(argc, argv) MSG_init(argc,argv)
315 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
317 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
318 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
320 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
321 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
322 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
323 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
325 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
326 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
328 XBT_PUBLIC(msg_error_t) MSG_clean(void);
330 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
331 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
333 double max_duration);
334 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
335 int channel, msg_host_t host);
336 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
339 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
340 m_channel_t channel);
341 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
345 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
348 double max_duration);
349 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
350 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
351 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
353 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
354 XBT_PUBLIC(int) MSG_get_channel_number(void);
357 /** @brief Opaque type describing a Virtual Machine.
360 * All this is highly experimental and the interface will probably change in the future.
361 * Please don't depend on this yet (although testing is welcomed if you feel so).
362 * Usual lack of guaranty of any kind applies here, and is even increased.
365 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
367 // TODO add VDI later
368 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
369 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
370 int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size);
372 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
374 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
375 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
377 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
379 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
381 /* Suspend the execution of the VM, but keep its state on memory. */
382 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
383 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
385 /* Save the VM state to a disk. */
386 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
387 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
389 /* Shutdown the guest operating system. */
390 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
392 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
394 /* TODO: do we need this? */
395 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
398 void* MSG_process_get_property(msg_process_t, char* key)
399 void MSG_process_set_property(msg_process_t, char* key, void* data)
400 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
402 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
403 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
404 // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
405 // <100 si c'est pas CPU intensive)
406 // Contraintes à poser:
407 // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
408 // VM_coreAmount >= Load de toutes les tasks
412 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
413 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
414 + des fonctions de filtrage sur les dynar
416 #include "instr/instr.h"
420 /* ****************************************************************************************** */
421 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
422 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
424 /* ****************************************************************************************** */
425 /* TUTORIAL: New API */
426 /* Declare all functions for the API */
427 /* ****************************************************************************************** */
428 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);