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"
13 #include "xbt/automaton.h"
18 /************************** Global ******************************************/
19 XBT_PUBLIC(void) MSG_config(const char *name, ...);
20 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
21 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
22 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
23 XBT_PUBLIC(int) MSG_get_channel_number(void);
24 XBT_PUBLIC(MSG_error_t) MSG_main(void);
25 XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
26 XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a, char *prgm);
27 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
28 XBT_PUBLIC(void) MSG_function_register(const char *name,
29 xbt_main_func_t code);
30 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
31 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
32 XBT_PUBLIC(void) MSG_launch_application(const char *file);
33 /*Bypass the parser */
34 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
35 const char *function_name,
36 xbt_dynar_t arguments);
38 XBT_PUBLIC(double) MSG_get_clock(void);
39 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
42 /************************** File handling ***********************************/
43 XBT_PUBLIC(size_t) MSG_file_read(void* ptr, size_t size, size_t nmemb, m_file_t* stream);
44 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, m_file_t* stream);
45 XBT_PUBLIC(m_file_t*) MSG_file_open(const char* path, const char* mode);
46 XBT_PUBLIC(int) MSG_file_close(m_file_t* fp);
47 XBT_PUBLIC(int) MSG_file_stat(int fd, void* buf);
50 /************************** Host handling ***********************************/
51 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
52 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
53 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
54 XBT_PUBLIC(m_host_t) MSG_host_self(void);
55 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
56 /* int MSG_get_msgload(void); This function lacks specification; discard it */
57 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
58 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
59 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
62 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
63 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
66 XBT_PUBLIC(void) MSG_create_environment(const char *file);
67 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
69 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
70 XBT_PUBLIC(int) MSG_get_host_number(void);
71 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
73 /************************** Process handling *********************************/
74 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
76 void *data, m_host_t host);
77 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
83 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
93 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
94 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
96 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
98 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
99 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
101 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
102 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
103 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
104 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
105 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
106 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
107 XBT_PUBLIC(int) MSG_process_self_PID(void);
108 XBT_PUBLIC(int) MSG_process_self_PPID(void);
109 XBT_PUBLIC(m_process_t) MSG_process_self(void);
111 /*property handlers*/
112 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
113 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
117 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
118 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
119 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
121 /************************** Task handling ************************************/
123 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
124 double compute_duration,
125 double message_size, void *data);
126 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
128 const m_host_t * host_list,
129 double *computation_amount,
130 double *communication_amount,
132 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
133 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
134 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
135 m_task_t task, m_process_t src, m_process_t dst));
136 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
137 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
138 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
139 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
140 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
141 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
143 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
144 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
146 double max_duration);
147 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
148 int channel, m_host_t host);
149 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
151 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
156 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
157 m_channel_t channel);
158 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
162 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
165 double max_duration);
166 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
167 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
168 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
170 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
171 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
172 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
173 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
175 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
176 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
177 double compute_duration);
178 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
179 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
180 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
181 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
184 XBT_PUBLIC(MSG_error_t)
185 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
188 XBT_PUBLIC(MSG_error_t)
189 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
192 XBT_PUBLIC(MSG_error_t)
193 MSG_task_receive(m_task_t * task, const char *alias);
194 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
196 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
197 XBT_INLINE XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, const char *alias,
198 int (*match_fun)(void*,void*),
201 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
202 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
203 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
204 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
205 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
206 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
207 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
209 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
210 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
211 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
213 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
215 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
218 XBT_PUBLIC(MSG_error_t)
219 MSG_task_send_with_timeout(m_task_t task, const char *alias,
222 XBT_PUBLIC(MSG_error_t)
223 MSG_task_send(m_task_t task, const char *alias);
225 XBT_PUBLIC(MSG_error_t)
226 MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
228 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
230 /************************** Task handling ************************************/
231 XBT_PUBLIC(MSG_error_t)
232 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
233 m_host_t host, double timeout);
235 XBT_PUBLIC(MSG_error_t)
236 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
239 /************************** Action handling **********************************/
240 typedef void (*msg_action_fun) (const char *const *args);
241 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
242 msg_action_fun function);
243 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
244 MSG_error_t MSG_action_trace_run(char *path);
246 #ifdef MSG_USE_DEPRECATED
247 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
248 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
249 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
250 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
251 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
253 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
254 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
257 #include "instr/instr.h"
259 /* Used only by the bindings */
260 #include "simix/simix.h"
261 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);