Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Enhance the communication filtering mechanism
[simgrid.git] / include / msg / msg.h
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef MSG_H
8 #define MSG_H
9
10 #include "xbt.h"
11
12 #include "msg/datatypes.h"
13 #include "xbt/automaton.h"
14
15 #include "simix/simix.h"
16
17 SG_BEGIN_DECL()
18
19 /** @brief Return code of most MSG functions
20     @ingroup msg_simulation
21     @{ */
22 /* Keep these code as binary values: java bindings manipulate | of these values */
23 typedef enum {
24   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
25   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
26   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
27       transfer. Either the network is down or the remote host has been
28       shutdown. */
29   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
30       running has just been rebooted. Free your datastructures and
31       return now !*/
32   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
33 } MSG_error_t;
34 /** @} */
35
36
37 /************************** Global ******************************************/
38 XBT_PUBLIC(void) MSG_config(const char *name, ...);
39 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
40 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
41 XBT_PUBLIC(MSG_error_t) MSG_main(void);
42 XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
43 XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a, char *prgm);
44 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
45 XBT_PUBLIC(void) MSG_function_register(const char *name,
46                                        xbt_main_func_t code);
47 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
48 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
49 XBT_PUBLIC(void) MSG_launch_application(const char *file);
50 /*Bypass the parser */
51 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
52                                   const char *function_name,
53                                   xbt_dynar_t arguments);
54
55 XBT_PUBLIC(double) MSG_get_clock(void);
56 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
57
58
59 /************************** File handling ***********************************/
60 XBT_PUBLIC(size_t) MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, msg_file_t stream);
61 XBT_PUBLIC(size_t) MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
62 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* storage, const char* path, const char* mode);
63 XBT_PUBLIC(int) MSG_file_close(const char* storage, msg_file_t fp);
64 XBT_PUBLIC(int) MSG_file_stat(const char* storage, msg_file_t fd, s_msg_stat_t *buf);
65
66
67 /************************** Host handling ***********************************/
68 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
69 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
70 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
71 XBT_PUBLIC(m_host_t) MSG_host_self(void);
72 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
73 /* int MSG_get_msgload(void); This function lacks specification; discard it */
74 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
75 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
76 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
77
78 /*property handlers*/
79 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
80 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
81                                                      const char *name);
82
83 XBT_PUBLIC(void) MSG_create_environment(const char *file);
84 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
85
86 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
87 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
88
89 /************************** Process handling *********************************/
90 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
91                                            xbt_main_func_t code,
92                                            void *data, m_host_t host);
93 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
94                                                           xbt_main_func_t
95                                                           code, void *data,
96                                                           m_host_t host,
97                                                           int argc,
98                                                           char **argv);
99 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
100                                                             *name,
101                                                             xbt_main_func_t
102                                                             code,
103                                                             void *data,
104                                                             m_host_t host,
105                                                             int argc,
106                                                             char **argv,
107                                                             xbt_dict_t
108                                                             properties);
109 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
110 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
111
112 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
113
114 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
115 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
116                                              void *data);
117 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
118 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
119 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
120 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
121 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
122 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
123 XBT_PUBLIC(int) MSG_process_self_PID(void);
124 XBT_PUBLIC(int) MSG_process_self_PPID(void);
125 XBT_PUBLIC(m_process_t) MSG_process_self(void);
126 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
127
128 /*property handlers*/
129 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
130 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
131                                                         process,
132                                                         const char *name);
133
134 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
135 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
136 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
137
138 /************************** Task handling ************************************/
139 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
140                                      double compute_duration,
141                                      double message_size, void *data);
142 XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name,
143                                      double compute_duration,
144                                      double dispatch_latency,
145                                      double collect_latency);
146 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
147                                               int host_nb,
148                                               const m_host_t * host_list,
149                                               double *computation_amount,
150                                               double *communication_amount,
151                                               void *data);
152 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
153 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
154 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
155     m_task_t task, m_process_t src, m_process_t dst));
156 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
157 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
158 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
159 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
160 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
161 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
162
163 XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(m_task_t * task, const char *alias,
164                                        m_host_t host);
165
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);
169
170 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
171
172 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
173 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
174                                                double compute_duration);
175 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
176 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
177 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
178 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
179
180
181 XBT_PUBLIC(MSG_error_t)
182     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
183                      m_host_t host);
184
185 XBT_PUBLIC(MSG_error_t)
186     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
187                               double timeout);
188
189 XBT_PUBLIC(MSG_error_t)
190     MSG_task_receive(m_task_t * task, const char *alias);
191 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
192
193 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
194 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task,
195                                                     const char *alias,
196                                                     int (*match_fun)(void*,void*, smx_action_t),
197                                                     void *match_data);
198
199 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
200 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
201 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
202 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
203 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
204 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
205 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
206                                   double timeout);
207 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
208 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
209 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
210
211 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
212
213 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
214                                           m_host_t host);
215
216 XBT_PUBLIC(MSG_error_t)
217     MSG_task_send_with_timeout(m_task_t task, const char *alias,
218                            double timeout);
219
220 XBT_PUBLIC(MSG_error_t)
221     MSG_task_send(m_task_t task, const char *alias);
222
223 XBT_PUBLIC(MSG_error_t)
224     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
225
226 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
227
228 XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category);
229 XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task);
230
231 /************************** Task handling ************************************/
232 XBT_PUBLIC(MSG_error_t)
233     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
234                          m_host_t host, double timeout);
235
236 XBT_PUBLIC(MSG_error_t)
237     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
238                              double timeout);
239
240 /************************** Action handling **********************************/
241 typedef void (*msg_action_fun) (const char *const *args);
242 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
243                                      msg_action_fun function);
244 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
245 MSG_error_t MSG_action_trace_run(char *path);
246
247 #ifdef MSG_USE_DEPRECATED
248 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
249 XBT_PUBLIC(int) MSG_get_host_number(void);
250 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
251
252 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
253 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
254 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
255         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
256
257 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
258 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
259
260 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
261 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
262                                                   m_channel_t channel,
263                                                   double max_duration);
264 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
265                                                int channel, m_host_t host);
266 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
267                                          double max_duration,
268                                          m_host_t host);
269 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
270                                      m_channel_t channel);
271 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
272                                              m_host_t dest,
273                                              m_channel_t channel,
274                                              double max_rate);
275 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
276                                                   m_host_t dest,
277                                                   m_channel_t channel,
278                                                   double max_duration);
279 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
280 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
281 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
282
283 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
284 XBT_PUBLIC(int) MSG_get_channel_number(void);
285 #endif
286
287 #include "instr/instr.h"
288
289 /* Used only by the bindings */
290 #include "simix/simix.h"
291 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
292
293 SG_END_DECL()
294 #endif