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_main(void);
23 XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
24 XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a, char *prgm);
25 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
26 XBT_PUBLIC(void) MSG_function_register(const char *name,
27 xbt_main_func_t code);
28 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
29 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
30 XBT_PUBLIC(void) MSG_launch_application(const char *file);
31 /*Bypass the parser */
32 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
33 const char *function_name,
34 xbt_dynar_t arguments);
36 XBT_PUBLIC(double) MSG_get_clock(void);
37 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
40 /************************** File handling ***********************************/
41 XBT_PUBLIC(size_t) MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, m_file_t stream);
42 XBT_PUBLIC(size_t) MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, m_file_t stream);
43 XBT_PUBLIC(m_file_t) MSG_file_open(const char* storage, const char* path, const char* mode);
44 XBT_PUBLIC(int) MSG_file_close(const char* storage, m_file_t fp);
45 XBT_PUBLIC(int) MSG_file_stat(const char* storage, int fd, void* buf);
48 /************************** Host handling ***********************************/
49 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
50 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
51 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
52 XBT_PUBLIC(m_host_t) MSG_host_self(void);
53 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
54 /* int MSG_get_msgload(void); This function lacks specification; discard it */
55 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
56 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
57 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
60 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
61 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
64 XBT_PUBLIC(void) MSG_create_environment(const char *file);
65 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
67 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
68 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
70 /************************** Process handling *********************************/
71 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
73 void *data, m_host_t host);
74 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
80 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
90 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
91 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
93 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
95 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
96 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
98 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
99 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
100 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
101 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
102 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
103 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
104 XBT_PUBLIC(int) MSG_process_self_PID(void);
105 XBT_PUBLIC(int) MSG_process_self_PPID(void);
106 XBT_PUBLIC(m_process_t) MSG_process_self(void);
107 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
109 /*property handlers*/
110 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
111 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
115 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
116 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
117 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
119 /************************** Task handling ************************************/
120 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
121 double compute_duration,
122 double message_size, void *data);
123 XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name,
124 double compute_duration,
125 double dispatch_latency,
126 double collect_latency);
127 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
129 const m_host_t * host_list,
130 double *computation_amount,
131 double *communication_amount,
133 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
134 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
135 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
136 m_task_t task, m_process_t src, m_process_t dst));
137 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
138 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
139 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
140 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
141 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
142 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
144 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
147 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
148 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
149 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
151 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
153 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
154 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
155 double compute_duration);
156 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
157 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
158 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
159 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
162 XBT_PUBLIC(MSG_error_t)
163 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
166 XBT_PUBLIC(MSG_error_t)
167 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
170 XBT_PUBLIC(MSG_error_t)
171 MSG_task_receive(m_task_t * task, const char *alias);
172 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
174 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
175 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task,
177 int (*match_fun)(void*,void*),
180 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
181 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
182 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
183 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
184 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
185 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
186 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
188 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
189 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
190 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
192 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
194 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
197 XBT_PUBLIC(MSG_error_t)
198 MSG_task_send_with_timeout(m_task_t task, const char *alias,
201 XBT_PUBLIC(MSG_error_t)
202 MSG_task_send(m_task_t task, const char *alias);
204 XBT_PUBLIC(MSG_error_t)
205 MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
207 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
209 /************************** Task handling ************************************/
210 XBT_PUBLIC(MSG_error_t)
211 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
212 m_host_t host, double timeout);
214 XBT_PUBLIC(MSG_error_t)
215 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
218 /************************** Action handling **********************************/
219 typedef void (*msg_action_fun) (const char *const *args);
220 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
221 msg_action_fun function);
222 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
223 MSG_error_t MSG_action_trace_run(char *path);
225 #ifdef MSG_USE_DEPRECATED
226 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
227 XBT_PUBLIC(int) MSG_get_host_number(void);
228 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
230 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
231 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
232 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
233 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
235 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
236 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
238 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
239 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
241 double max_duration);
242 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
243 int channel, m_host_t host);
244 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
247 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
248 m_channel_t channel);
249 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
253 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
256 double max_duration);
257 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
258 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
259 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
261 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
262 XBT_PUBLIC(int) MSG_get_channel_number(void);
265 #include "instr/instr.h"
267 /* Used only by the bindings */
268 #include "simix/simix.h"
269 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);