Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Deprecate functions MSG_global_init() / MSG_global_init_args() in flavor of MSG_init()
[simgrid.git] / include / msg / msg.h
1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef MSG_H
7 #define MSG_H
8
9 #include "xbt.h"
10
11 #include "msg/datatypes.h"
12 #include "xbt/automaton.h"
13
14 #include "simgrid/simix.h"
15
16 SG_BEGIN_DECL()
17
18 /** @brief Return code of most MSG functions
19     @ingroup msg_simulation
20     @{ */
21 /* Keep these code as binary values: java bindings manipulate | of these values */
22 typedef enum {
23   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
24   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
25   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
26       transfer. Either the network is down or the remote host has been
27       shutdown. */
28   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
29       running has just been rebooted. Free your datastructures and
30       return now !*/
31   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
32 } MSG_error_t;
33 /** @} */
34
35
36 /************************** Global ******************************************/
37 XBT_PUBLIC(void) MSG_config(const char *name, ...);
38 /** \ingroup msg_simulation
39  *  \brief Initialize the MSG internal data.
40  *  \hideinitializer
41  *
42  *  It also check that the link-time and compile-time versions of SimGrid do
43  *  match, so you should use this version instead of the #MSG_init_nocheck
44  *  function that does the same initializations, but without this check.
45  *
46  *  We allow to link against compiled versions that differ in the patch level.
47  */
48 #define MSG_init(argc,argv)  {                      \
49           int ver_major,ver_minor,ver_patch;              \
50           sg_version(&ver_major,&ver_minor,&ver_patch);   \
51           if ((ver_major != SIMGRID_VERSION_MAJOR) ||     \
52               (ver_minor != SIMGRID_VERSION_MINOR)) {     \
53             fprintf(stderr,"FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, and then linked against SimGrid %d.%d.%d. Please fix this.\n", \
54                 SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch);                          \
55           }                                               \
56           MSG_init_nocheck(argc,argv);                    \
57         }
58
59 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
60 XBT_PUBLIC(MSG_error_t) MSG_main(void);
61 XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
62 XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a);
63 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
64 XBT_PUBLIC(void) MSG_function_register(const char *name,
65                                        xbt_main_func_t code);
66 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
67 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
68 XBT_PUBLIC(void) MSG_launch_application(const char *file);
69 /*Bypass the parser */
70 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
71                                   const char *function_name,
72                                   xbt_dynar_t arguments);
73
74 XBT_PUBLIC(double) MSG_get_clock(void);
75 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
76
77
78 /************************** File handling ***********************************/
79 XBT_PUBLIC(size_t) MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t stream);
80 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
81 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode);
82 XBT_PUBLIC(int) MSG_file_close(msg_file_t fp);
83 XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf);
84
85
86 /************************** Host handling ***********************************/
87 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
88 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
89 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
90 XBT_PUBLIC(m_host_t) MSG_host_self(void);
91 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
92 /* int MSG_get_msgload(void); This function lacks specification; discard it */
93 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
94 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
95 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
96
97 /*property handlers*/
98 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
99 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
100                                                      const char *name);
101 XBT_PUBLIC(void) MSG_host_set_property_value(m_host_t host,
102                                              const char *name, char *value,
103                                              void_f_pvoid_t free_ctn);
104
105
106 XBT_PUBLIC(void) MSG_create_environment(const char *file);
107 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
108
109 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
110 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
111
112 /************************** Process handling *********************************/
113 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
114                                            xbt_main_func_t code,
115                                            void *data, m_host_t host);
116 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
117                                                           xbt_main_func_t
118                                                           code, void *data,
119                                                           m_host_t host,
120                                                           int argc,
121                                                           char **argv);
122 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
123                                                             *name,
124                                                             xbt_main_func_t
125                                                             code,
126                                                             void *data,
127                                                             m_host_t host,
128                                                             int argc,
129                                                             char **argv,
130                                                             xbt_dict_t
131                                                             properties);
132 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
133 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
134
135 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
136
137 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
138 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
139                                              void *data);
140 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
141 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
142 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
143 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
144 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
145 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
146 XBT_PUBLIC(int) MSG_process_self_PID(void);
147 XBT_PUBLIC(int) MSG_process_self_PPID(void);
148 XBT_PUBLIC(m_process_t) MSG_process_self(void);
149 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
150 XBT_PUBLIC(MSG_error_t) MSG_process_set_kill_time(m_process_t process, double kill_time);
151
152 /*property handlers*/
153 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
154 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
155                                                         process,
156                                                         const char *name);
157
158 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
159 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
160 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
161 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
162
163 /************************** Task handling ************************************/
164 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
165                                      double compute_duration,
166                                      double message_size, void *data);
167 XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name,
168                                      double compute_duration,
169                                      double dispatch_latency,
170                                      double collect_latency);
171 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
172                                               int host_nb,
173                                               const m_host_t * host_list,
174                                               double *computation_amount,
175                                               double *communication_amount,
176                                               void *data);
177 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
178 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
179 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
180     m_task_t task, m_process_t src, m_process_t dst));
181 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
182 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
183 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
184 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
185 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
186 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
187
188 XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(m_task_t * task, const char *alias,
189                                        m_host_t host);
190
191 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
192 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
193 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
194
195 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
196
197 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
198 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
199                                                double compute_duration);
200 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
201 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
202 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
203 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
204
205
206 XBT_PUBLIC(MSG_error_t)
207     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
208                      m_host_t host);
209
210 XBT_PUBLIC(MSG_error_t)
211     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
212                               double timeout);
213
214 XBT_PUBLIC(MSG_error_t)
215     MSG_task_receive(m_task_t * task, const char *alias);
216 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
217
218 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
219 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task,
220                                                     const char *alias,
221                                                     int (*match_fun)(void*,void*, smx_action_t),
222                                                     void *match_data);
223
224 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
225 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
226 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
227 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
228 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
229 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
230 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
231                                   double timeout);
232 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
233 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
234 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
235
236 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
237
238 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
239                                           m_host_t host);
240
241 XBT_PUBLIC(MSG_error_t)
242     MSG_task_send_with_timeout(m_task_t task, const char *alias,
243                            double timeout);
244
245 XBT_PUBLIC(MSG_error_t)
246     MSG_task_send(m_task_t task, const char *alias);
247
248 XBT_PUBLIC(MSG_error_t)
249     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
250
251 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
252
253 XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category);
254 XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task);
255
256 /************************** Task handling ************************************/
257 XBT_PUBLIC(MSG_error_t)
258     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
259                          m_host_t host, double timeout);
260
261 XBT_PUBLIC(MSG_error_t)
262     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
263                              double timeout);
264
265 /************************** Action handling **********************************/
266 MSG_error_t MSG_action_trace_run(char *path);
267
268 #ifdef MSG_USE_DEPRECATED
269 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
270 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
271
272 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
273 XBT_PUBLIC(int) MSG_get_host_number(void);
274 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
275
276 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
277 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
278 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
279         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
280
281 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
282 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
283
284 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
285 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
286                                                   m_channel_t channel,
287                                                   double max_duration);
288 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
289                                                int channel, m_host_t host);
290 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
291                                          double max_duration,
292                                          m_host_t host);
293 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
294                                      m_channel_t channel);
295 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
296                                              m_host_t dest,
297                                              m_channel_t channel,
298                                              double max_rate);
299 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
300                                                   m_host_t dest,
301                                                   m_channel_t channel,
302                                                   double max_duration);
303 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
304 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
305 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
306
307 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
308 XBT_PUBLIC(int) MSG_get_channel_number(void);
309 #endif
310
311 #include "instr/instr.h"
312
313 /** @brief Opaque type describing a Virtual Machine.
314  *  @ingroup msg_VMs
315  *
316  * All this is highly experimental and the interface will probably change in the future.
317  * Please don't depend on this yet (although testing is welcomed if you feel so).
318  * Usual lack of guaranty of any kind applies here, and is even increased.
319  *
320  */
321 typedef struct msg_vm *msg_vm_t;
322 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
323 XBT_PUBLIC(msg_vm_t) MSG_vm_start(m_host_t location, int coreAmount);
324
325 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
326 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
327
328 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, m_process_t process);
329 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, m_process_t process); // simple wrapper over process_kill
330
331 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, m_host_t destination);
332
333 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
334   // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
335
336 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);  // Simulate the fact of reading the processes from disk and resuming them
337   // \forall p in VM, MSG_process_resume(p) // unfreeze them
338
339 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
340
341 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
342
343 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
344
345 /*
346 void* MSG_process_get_property(msg_process_t, char* key)
347 void MSG_process_set_property(msg_process_t, char* key, void* data)
348 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
349
350 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
351 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
352   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
353   //                              <100 si c'est pas CPU intensive)
354   // Contraintes à poser:
355   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
356   //   VM_coreAmount >= Load de toutes les tasks
357 */
358
359   /*
360 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
361 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
362 + des fonctions de filtrage sur les dynar
363 */
364
365
366 /* ****************************************************************************************** */
367 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
368 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
369
370 SG_END_DECL()
371 #endif