Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
new function: MSG_action_paranoid_mode_set (allowing to tell the parser that our...
[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 SG_BEGIN_DECL()
14
15
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);
33
34 XBT_INLINE XBT_PUBLIC(double) MSG_get_clock(void);
35 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
36
37
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);
47
48 /*property handlers*/
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,
51                                                      const char *name);
52
53 XBT_PUBLIC(void) MSG_create_environment(const char *file);
54 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
55
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);
59
60 /************************** Process handling *********************************/
61 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
62                                            xbt_main_func_t code,
63                                            void *data, m_host_t host);
64 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
65                                                           xbt_main_func_t
66                                                           code, void *data,
67                                                           m_host_t host,
68                                                           int argc,
69                                                           char **argv);
70 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
71                                                             *name,
72                                                             xbt_main_func_t
73                                                             code,
74                                                             void *data,
75                                                             m_host_t host,
76                                                             int argc,
77                                                             char **argv,
78                                                             xbt_dict_t
79                                                             properties);
80 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
81 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
82
83 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
84
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,
87                                              void *data);
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);
96
97 /*property handlers*/
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
100                                                         process,
101                                                         const char *name);
102
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);
106
107 /************************** Task handling ************************************/
108
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,
113                                               int host_nb,
114                                               const m_host_t * host_list,
115                                               double *computation_amount,
116                                               double *communication_amount,
117                                               void *data);
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);
126 XBT_PUBLIC(void) MSG_task_refcount_dec(m_task_t task);
127
128 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
129 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
130                                                   m_channel_t channel,
131                                                   double max_duration);
132 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
133                                                int channel, m_host_t host);
134 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
135                                        m_host_t host);
136 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
137                                          double max_duration,
138                                          m_host_t host);
139
140
141 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
142                                      m_channel_t channel);
143 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
144                                              m_host_t dest,
145                                              m_channel_t channel,
146                                              double max_rate);
147 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
148                                                   m_host_t dest,
149                                                   m_channel_t channel,
150                                                   double max_duration);
151 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
152 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
153 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
154
155 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
156 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
157 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
158 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
159 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
160
161 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
162 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
163                                                double compute_duration);
164 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
165 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
166 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
167 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
168
169
170 XBT_PUBLIC(MSG_error_t)
171     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
172                      m_host_t host);
173
174 XBT_PUBLIC(MSG_error_t)
175     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
176                               double timeout);
177
178 XBT_PUBLIC(MSG_error_t)
179     MSG_task_receive(m_task_t * task, const char *alias);
180
181 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
182 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
183 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
184 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
185 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
186 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
187 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
188                                   double timeout);
189 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
190 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
191
192 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
193
194 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
195                                           m_host_t host);
196
197 XBT_PUBLIC(MSG_error_t)
198     MSG_task_send_with_timeout(m_task_t task, const char *alias,
199                            double timeout);
200
201 XBT_PUBLIC(MSG_error_t)
202     MSG_task_send(m_task_t task, const char *alias);
203
204 XBT_PUBLIC(MSG_error_t)
205     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
206
207 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
208
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);
213
214 XBT_PUBLIC(MSG_error_t)
215     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
216                              double timeout);
217
218 /************************** Action handling **********************************/
219 typedef void (*msg_action_fun) (xbt_dynar_t args);
220 XBT_PUBLIC(void) MSG_action_paranoid_mode_set(int mode);
221 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
222                                      msg_action_fun function);
223 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
224 MSG_error_t MSG_action_trace_run(char *path);
225
226
227 #ifdef MSG_USE_DEPRECATED
228 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
229 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
230 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
231         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
232
233 #endif
234
235 #include "instr/instr.h"
236
237 /* Used only by the bindings */
238 #include "simix/simix.h"
239 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
240
241
242 SG_END_DECL()
243 #endif