Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
merge conflicts
[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 SG_BEGIN_DECL()
16
17
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_stateful(xbt_automaton_t a);
27 XBT_PUBLIC(MSG_error_t) MSG_main_liveness_stateless(xbt_automaton_t a, char *prgm);
28 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
29 XBT_PUBLIC(void) MSG_function_register(const char *name,
30                                        xbt_main_func_t code);
31 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
32 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
33 XBT_PUBLIC(void) MSG_launch_application(const char *file);
34 /*Bypass the parser */
35 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
36                                   const char *function_name,
37                                   xbt_dynar_t arguments);
38
39 XBT_PUBLIC(double) MSG_get_clock(void);
40 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
41
42
43 /************************** Host handling ***********************************/
44 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
45 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
46 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
47 XBT_PUBLIC(m_host_t) MSG_host_self(void);
48 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
49 /* int MSG_get_msgload(void); This function lacks specification; discard it */
50 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
51 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
52 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
53
54 /*property handlers*/
55 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
56 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
57                                                      const char *name);
58
59 XBT_PUBLIC(void) MSG_create_environment(const char *file);
60 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
61
62 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
63 XBT_PUBLIC(int) MSG_get_host_number(void);
64 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
65
66 /************************** Process handling *********************************/
67 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
68                                            xbt_main_func_t code,
69                                            void *data, m_host_t host);
70 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
71                                                           xbt_main_func_t
72                                                           code, void *data,
73                                                           m_host_t host,
74                                                           int argc,
75                                                           char **argv);
76 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
77                                                             *name,
78                                                             xbt_main_func_t
79                                                             code,
80                                                             void *data,
81                                                             m_host_t host,
82                                                             int argc,
83                                                             char **argv,
84                                                             xbt_dict_t
85                                                             properties);
86 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
87 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
88
89 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
90
91 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
92 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
93                                              void *data);
94 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
95 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
96 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
97 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
98 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
99 XBT_PUBLIC(int) MSG_process_self_PID(void);
100 XBT_PUBLIC(int) MSG_process_self_PPID(void);
101 XBT_PUBLIC(m_process_t) MSG_process_self(void);
102
103 /*property handlers*/
104 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
105 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
106                                                         process,
107                                                         const char *name);
108
109 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
110 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
111 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
112
113 /************************** Task handling ************************************/
114
115 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
116                                      double compute_duration,
117                                      double message_size, void *data);
118 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
119                                               int host_nb,
120                                               const m_host_t * host_list,
121                                               double *computation_amount,
122                                               double *communication_amount,
123                                               void *data);
124 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
125 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
126 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
127 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
128 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
129 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
130 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
131 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
132
133 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
134 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
135                                                   m_channel_t channel,
136                                                   double max_duration);
137 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
138                                                int channel, m_host_t host);
139 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
140                                        m_host_t host);
141 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
142                                          double max_duration,
143                                          m_host_t host);
144
145
146 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
147                                      m_channel_t channel);
148 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
149                                              m_host_t dest,
150                                              m_channel_t channel,
151                                              double max_rate);
152 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
153                                                   m_host_t dest,
154                                                   m_channel_t channel,
155                                                   double max_duration);
156 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
157 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
158 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
159
160 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
161 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
162 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
163 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
164
165 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
166 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
167                                                double compute_duration);
168 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
169 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
170 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
171 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
172
173
174 XBT_PUBLIC(MSG_error_t)
175     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
176                      m_host_t host);
177
178 XBT_PUBLIC(MSG_error_t)
179     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
180                               double timeout);
181
182 XBT_PUBLIC(MSG_error_t)
183     MSG_task_receive(m_task_t * task, const char *alias);
184 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
185
186 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
187 XBT_INLINE XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, const char *alias,
188                                                                int (*match_fun)(void*,void*),
189                                                                void *match_data);
190
191 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
192 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
193 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
194 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
195 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
196 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
197 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
198                                   double timeout);
199 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
200 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
201 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
202
203 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
204
205 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
206                                           m_host_t host);
207
208 XBT_PUBLIC(MSG_error_t)
209     MSG_task_send_with_timeout(m_task_t task, const char *alias,
210                            double timeout);
211
212 XBT_PUBLIC(MSG_error_t)
213     MSG_task_send(m_task_t task, const char *alias);
214
215 XBT_PUBLIC(MSG_error_t)
216     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
217
218 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
219
220 /************************** Task handling ************************************/
221 XBT_PUBLIC(MSG_error_t)
222     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
223                          m_host_t host, double timeout);
224
225 XBT_PUBLIC(MSG_error_t)
226     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
227                              double timeout);
228
229 /************************** Action handling **********************************/
230 typedef void (*msg_action_fun) (const char *const *args);
231 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
232                                      msg_action_fun function);
233 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
234 MSG_error_t MSG_action_trace_run(char *path);
235
236 #ifdef MSG_USE_DEPRECATED
237 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
238 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
239 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
240 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
241         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
242
243 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
244 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
245 #endif
246
247 #include "instr/instr.h"
248
249 /* Used only by the bindings */
250 #include "simix/simix.h"
251 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
252
253 SG_END_DECL()
254 #endif