Logo AND Algorithmique Numérique Distribuée

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