Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge remote-tracking branch 'github/master'
[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
13 #include "simgrid/simix.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 /************************** Global ******************************************/
35 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
36 /** \ingroup msg_simulation
37  *  \brief Initialize the MSG internal data.
38  *  \hideinitializer
39  *
40  *  It also check that the link-time and compile-time versions of SimGrid do
41  *  match, so you should use this version instead of the #MSG_init_nocheck
42  *  function that does the same initializations, but without this check.
43  *
44  *  We allow to link against compiled versions that differ in the patch level.
45  */
46 #define MSG_init(argc,argv)  {                      \
47           int ver_major,ver_minor,ver_patch;              \
48           sg_version(&ver_major,&ver_minor,&ver_patch);   \
49           if ((ver_major != SIMGRID_VERSION_MAJOR) ||     \
50               (ver_minor != SIMGRID_VERSION_MINOR)) {     \
51             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", \
52                 SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch);                          \
53           }                                               \
54           MSG_init_nocheck(argc,argv);                    \
55         }
56
57 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
58 XBT_PUBLIC(msg_error_t) MSG_main(void);
59 XBT_PUBLIC(void) MSG_function_register(const char *name,
60                                        xbt_main_func_t code);
61 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
62 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
63 XBT_PUBLIC(void) MSG_launch_application(const char *file);
64 /*Bypass the parser */
65 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
66                                   const char *function_name,
67                                   xbt_dynar_t arguments);
68
69 XBT_PUBLIC(double) MSG_get_clock(void);
70 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
71
72
73 /************************** File handling ***********************************/
74 XBT_PUBLIC(double) MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t stream);
75 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
76 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode);
77 XBT_PUBLIC(int) MSG_file_close(msg_file_t fp);
78 XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf);
79 XBT_PUBLIC(void) MSG_file_free_stat(s_msg_stat_t *stat);
80
81 XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
82 XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
83
84 /************************** AS Router handling ************************************/
85 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
86 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
87 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
88
89 /************************** Host handling ***********************************/
90 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
91 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
92 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
93 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
94 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
95 /* int MSG_get_msgload(void); This function lacks specification; discard it */
96 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
97 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
98 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_priv_t host);
99
100 /*property handlers*/
101 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
102 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
103                                                      const char *name);
104 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
105                                              const char *name, char *value,
106                                              void_f_pvoid_t free_ctn);
107
108
109 XBT_PUBLIC(void) MSG_create_environment(const char *file);
110
111 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
112 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
113 XBT_PUBLIC(int) MSG_get_host_number(void);
114
115 /************************** Process handling *********************************/
116 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
117                                            xbt_main_func_t code,
118                                            void *data, msg_host_t host);
119 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
120                                                           xbt_main_func_t
121                                                           code, void *data,
122                                                           msg_host_t host,
123                                                           int argc,
124                                                           char **argv);
125 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
126                                                             *name,
127                                                             xbt_main_func_t
128                                                             code,
129                                                             void *data,
130                                                             msg_host_t host,
131                                                             int argc,
132                                                             char **argv,
133                                                             xbt_dict_t
134                                                             properties);
135 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
136 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
137
138 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
139
140 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
141 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
142                                              void *data);
143 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
144 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
145 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
146 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
147 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
148 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
149 XBT_PUBLIC(int) MSG_process_self_PID(void);
150 XBT_PUBLIC(int) MSG_process_self_PPID(void);
151 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
152 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
153 XBT_PUBLIC(int) MSG_process_get_number(void);
154
155 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
156
157 /*property handlers*/
158 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
159 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
160                                                         process,
161                                                         const char *name);
162
163 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
164 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
165 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
166 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
167 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
168
169 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
170
171 /************************** Task handling ************************************/
172 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
173                                      double compute_duration,
174                                      double message_size, void *data);
175 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
176                                      double compute_duration,
177                                      double dispatch_latency,
178                                      double collect_latency);
179 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
180                                               int host_nb,
181                                               const msg_host_t * host_list,
182                                               double *computation_amount,
183                                               double *communication_amount,
184                                               void *data);
185 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
186 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
187 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
188     msg_task_t task, msg_process_t src, msg_process_t dst));
189 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
190 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
191 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
192 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
193 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
194 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
195
196 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
197                                        msg_host_t host);
198
199 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
200 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
201 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
202
203 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
204
205 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
206 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
207                                                double compute_duration);
208 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
209                                                double data_size);
210
211 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
212 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
213 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
214 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
215
216
217 XBT_PUBLIC(msg_error_t)
218     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
219                      msg_host_t host);
220
221 XBT_PUBLIC(msg_error_t)
222     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
223                               double timeout);
224
225 XBT_PUBLIC(msg_error_t)
226     MSG_task_receive(msg_task_t * task, const char *alias);
227 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
228
229 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
230 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
231 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
232                                                     const char *alias,
233                                                     int (*match_fun)(void*,void*, smx_action_t),
234                                                     void *match_data);
235
236 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
237 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
238 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
239 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
240 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
241 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
242 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
243 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
244                                   double timeout);
245 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
246 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
247 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
248
249 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
250
251 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
252                                           msg_host_t host);
253
254 XBT_PUBLIC(msg_error_t)
255     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
256                            double timeout);
257     
258 XBT_PUBLIC(msg_error_t)
259     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
260                            double timeout, double maxrate);
261
262 XBT_PUBLIC(msg_error_t)
263     MSG_task_send(msg_task_t task, const char *alias);
264
265 XBT_PUBLIC(msg_error_t)
266     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
267
268 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
269
270 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
271 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
272
273 /************************** Task handling ************************************/
274 XBT_PUBLIC(msg_error_t)
275     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
276                          msg_host_t host, double timeout);
277
278 XBT_PUBLIC(msg_error_t)
279     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
280                              double timeout);
281
282 void MSG_mailbox_set_async(const char *alias);
283
284
285 /************************** Action handling **********************************/
286 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
287
288 #ifdef MSG_USE_DEPRECATED
289
290 typedef msg_error_t MSG_error_t;
291
292 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
293 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
294
295 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
296 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
297
298 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
299 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
300 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
301         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
302
303 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
304 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
305
306 XBT_PUBLIC(msg_error_t) MSG_clean(void);
307
308 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
309 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
310                                                   m_channel_t channel,
311                                                   double max_duration);
312 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
313                                                int channel, msg_host_t host);
314 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
315                                          double max_duration,
316                                          msg_host_t host);
317 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
318                                      m_channel_t channel);
319 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
320                                              msg_host_t dest,
321                                              m_channel_t channel,
322                                              double max_rate);
323 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
324                                                   msg_host_t dest,
325                                                   m_channel_t channel,
326                                                   double max_duration);
327 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
328 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
329 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
330
331 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
332 XBT_PUBLIC(int) MSG_get_channel_number(void);
333 #endif
334
335 /** @brief Opaque type describing a Virtual Machine.
336  *  @ingroup msg_VMs
337  *
338  * All this is highly experimental and the interface will probably change in the future.
339  * Please don't depend on this yet (although testing is welcomed if you feel so).
340  * Usual lack of guaranty of any kind applies here, and is even increased.
341  *
342  */
343 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
344 XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, const char *name, int coreAmount);
345
346 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
347 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
348
349 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, msg_process_t process);
350 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, msg_process_t process); // simple wrapper over process_kill
351
352 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
353
354 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
355   // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
356
357 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);  // Simulate the fact of reading the processes from disk and resuming them
358   // \forall p in VM, MSG_process_resume(p) // unfreeze them
359
360 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
361
362 XBT_PUBLIC(void) MSG_vm_reboot(msg_vm_t vm);
363
364 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
365
366 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
367
368 /*
369 void* MSG_process_get_property(msg_process_t, char* key)
370 void MSG_process_set_property(msg_process_t, char* key, void* data)
371 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
372
373 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
374 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
375   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
376   //                              <100 si c'est pas CPU intensive)
377   // Contraintes à poser:
378   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
379   //   VM_coreAmount >= Load de toutes les tasks
380 */
381
382   /*
383 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
384 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
385 + des fonctions de filtrage sur les dynar
386 */
387 #include "instr/instr.h"
388
389
390
391 /* ****************************************************************************************** */
392 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
393 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
394
395 /* ****************************************************************************************** */
396 /* TUTORIAL: New API                                                                        */
397 /* Declare all functions for the API                                                          */
398 /* ****************************************************************************************** */
399 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);
400
401 SG_END_DECL()
402 #endif