1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 "msg/datatypes.h"
16 /************************** Global ******************************************/
17 XBT_PUBLIC(void) MSG_config(const char *name, ...);
18 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
19 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
20 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
21 XBT_PUBLIC(int) MSG_get_channel_number(void);
22 XBT_PUBLIC(MSG_error_t) MSG_main(void);
23 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
24 XBT_PUBLIC(void) MSG_function_register(const char *name,
25 xbt_main_func_t code);
26 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
27 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
28 XBT_PUBLIC(void) MSG_launch_application(const char *file);
29 /*Bypass the parser */
30 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
31 const char *function_name,
32 xbt_dynar_t arguments);
34 XBT_INLINE XBT_PUBLIC(double) MSG_get_clock(void);
35 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
38 /************************** Host handling ***********************************/
39 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
40 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
41 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
42 XBT_PUBLIC(m_host_t) MSG_host_self(void);
43 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
44 /* int MSG_get_msgload(void); This function lacks specification; discard it */
45 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
46 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
49 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
50 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
53 XBT_PUBLIC(void) MSG_create_environment(const char *file);
54 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
56 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
57 XBT_PUBLIC(int) MSG_get_host_number(void);
58 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
60 /************************** Process handling *********************************/
61 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
63 void *data, m_host_t host);
64 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
70 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
80 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
81 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
83 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
85 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
86 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
88 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
89 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
90 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
91 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
92 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
93 XBT_PUBLIC(int) MSG_process_self_PID(void);
94 XBT_PUBLIC(int) MSG_process_self_PPID(void);
95 XBT_PUBLIC(m_process_t) MSG_process_self(void);
98 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
99 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
103 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
104 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
105 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
107 /************************** Task handling ************************************/
109 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
110 double compute_duration,
111 double message_size, void *data);
112 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
114 const m_host_t * host_list,
115 double *computation_amount,
116 double *communication_amount,
118 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
119 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
120 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
121 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
122 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
123 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
124 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
125 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
127 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
128 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
130 double max_duration);
131 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
132 int channel, m_host_t host);
133 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
135 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
140 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
141 m_channel_t channel);
142 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
146 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
149 double max_duration);
150 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
151 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
152 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
154 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
155 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
156 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
157 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
158 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
160 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
161 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
162 double compute_duration);
163 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
164 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
165 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
166 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
169 XBT_PUBLIC(MSG_error_t)
170 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
173 XBT_PUBLIC(MSG_error_t)
174 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
177 XBT_PUBLIC(MSG_error_t)
178 MSG_task_receive(m_task_t * task, const char *alias);
180 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
181 XBT_INLINE XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, const char *alias,
182 int (*match_fun)(void*,void*),
185 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
186 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
187 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
188 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
189 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
190 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
191 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
193 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
194 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
195 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
197 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
199 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
202 XBT_PUBLIC(MSG_error_t)
203 MSG_task_send_with_timeout(m_task_t task, const char *alias,
206 XBT_PUBLIC(MSG_error_t)
207 MSG_task_send(m_task_t task, const char *alias);
209 XBT_PUBLIC(MSG_error_t)
210 MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
212 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
214 /************************** Task handling ************************************/
215 XBT_PUBLIC(MSG_error_t)
216 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
217 m_host_t host, double timeout);
219 XBT_PUBLIC(MSG_error_t)
220 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
223 /************************** Action handling **********************************/
224 typedef void (*msg_action_fun) (const char *const *args);
225 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
226 msg_action_fun function);
227 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
228 MSG_error_t MSG_action_trace_run(char *path);
230 #ifdef MSG_USE_DEPRECATED
231 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
232 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
233 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
234 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
236 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
239 #include "instr/instr.h"
241 /* Used only by the bindings */
242 #include "simix/simix.h"
243 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);