Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
891eb33f9a14fa3c2fa4b1cc0e850cb2a786917d
[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(size_t) 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
79 XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
80 XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
81
82 /************************** AS Router handling ************************************/
83 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
84 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
85 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
86
87 /************************** Host handling ***********************************/
88 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
89 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
90 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
91 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
92 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
93 /* int MSG_get_msgload(void); This function lacks specification; discard it */
94 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
95 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
96 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_priv_t host);
97
98 /*property handlers*/
99 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
100 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
101                                                      const char *name);
102 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
103                                              const char *name, char *value,
104                                              void_f_pvoid_t free_ctn);
105
106
107 XBT_PUBLIC(void) MSG_create_environment(const char *file);
108
109 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
110 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
111 XBT_PUBLIC(int) MSG_get_host_number(void);
112
113 /************************** Process handling *********************************/
114 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
115                                            xbt_main_func_t code,
116                                            void *data, msg_host_t host);
117 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
118                                                           xbt_main_func_t
119                                                           code, void *data,
120                                                           msg_host_t host,
121                                                           int argc,
122                                                           char **argv);
123 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
124                                                             *name,
125                                                             xbt_main_func_t
126                                                             code,
127                                                             void *data,
128                                                             msg_host_t host,
129                                                             int argc,
130                                                             char **argv,
131                                                             xbt_dict_t
132                                                             properties);
133 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
134 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
135
136 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
137
138 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
139 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
140                                              void *data);
141 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
142 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
143 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
144 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
145 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
146 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
147 XBT_PUBLIC(int) MSG_process_self_PID(void);
148 XBT_PUBLIC(int) MSG_process_self_PPID(void);
149 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
150 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
151 XBT_PUBLIC(int) MSG_process_get_number(void);
152
153 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
154
155 /*property handlers*/
156 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
157 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
158                                                         process,
159                                                         const char *name);
160
161 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
162 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
163 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
164 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
165 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
166
167 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
168
169 /************************** Task handling ************************************/
170 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
171                                      double compute_duration,
172                                      double message_size, void *data);
173 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
174                                      double compute_duration,
175                                      double dispatch_latency,
176                                      double collect_latency);
177 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
178                                               int host_nb,
179                                               const msg_host_t * host_list,
180                                               double *computation_amount,
181                                               double *communication_amount,
182                                               void *data);
183 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
184 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
185 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
186     msg_task_t task, msg_process_t src, msg_process_t dst));
187 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
188 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
189 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
190 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
191 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
192 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
193
194 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
195                                        msg_host_t host);
196 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
197                                        msg_host_t host, double rate);
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
230
231 XBT_PUBLIC(msg_error_t)
232     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
233                      msg_host_t host, double rate);
234
235 XBT_PUBLIC(msg_error_t)
236     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
237                               double timeout, double rate);
238
239 XBT_PUBLIC(msg_error_t)
240     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
241 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
242
243 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
244 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
245 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
246                                                     const char *alias,
247                                                     int (*match_fun)(void*,void*, smx_action_t),
248                                                     void *match_data);
249
250 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
251 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
252 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
253 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
254 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
255 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
256 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
257 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
258 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
259                                   double timeout);
260 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
261 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
262 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
263
264 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
265
266 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
267                                           msg_host_t host);
268
269 XBT_PUBLIC(msg_error_t)
270     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
271                            double timeout);
272
273 XBT_PUBLIC(msg_error_t)
274     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
275                            double timeout, double maxrate);
276
277 XBT_PUBLIC(msg_error_t)
278     MSG_task_send(msg_task_t task, const char *alias);
279
280 XBT_PUBLIC(msg_error_t)
281     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
282
283 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
284
285 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
286 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
287
288 /************************** Task handling ************************************/
289 XBT_PUBLIC(msg_error_t)
290     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
291                          msg_host_t host, double timeout);
292
293 XBT_PUBLIC(msg_error_t)
294     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
295                                      msg_host_t host, double timeout, double rate);
296
297 XBT_PUBLIC(msg_error_t)
298     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
299                              double timeout);
300
301 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
302
303
304 /************************** Action handling **********************************/
305 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
306
307 #ifdef MSG_USE_DEPRECATED
308
309 typedef msg_error_t MSG_error_t;
310
311 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
312 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
313
314 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
315 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
316
317 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
318 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
319 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
320         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
321
322 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
323 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
324
325 XBT_PUBLIC(msg_error_t) MSG_clean(void);
326
327 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
328 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
329                                                   m_channel_t channel,
330                                                   double max_duration);
331 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
332                                                int channel, msg_host_t host);
333 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
334                                          double max_duration,
335                                          msg_host_t host);
336 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
337                                      m_channel_t channel);
338 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
339                                              msg_host_t dest,
340                                              m_channel_t channel,
341                                              double max_rate);
342 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
343                                                   msg_host_t dest,
344                                                   m_channel_t channel,
345                                                   double max_duration);
346 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
347 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
348 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
349
350 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
351 XBT_PUBLIC(int) MSG_get_channel_number(void);
352 #endif
353
354 /** @brief Opaque type describing a Virtual Machine.
355  *  @ingroup msg_VMs
356  *
357  * All this is highly experimental and the interface will probably change in the future.
358  * Please don't depend on this yet (although testing is welcomed if you feel so).
359  * Usual lack of guaranty of any kind applies here, and is even increased.
360  *
361  */
362 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
363 XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, const char *name, int coreAmount);
364
365 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
366 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
367
368 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, msg_process_t process);
369 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, msg_process_t process); // simple wrapper over process_kill
370
371 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
372
373 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
374   // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
375
376 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);  // Simulate the fact of reading the processes from disk and resuming them
377   // \forall p in VM, MSG_process_resume(p) // unfreeze them
378
379 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
380
381 XBT_PUBLIC(void) MSG_vm_reboot(msg_vm_t vm);
382
383 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
384
385 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
386
387 /*
388 void* MSG_process_get_property(msg_process_t, char* key)
389 void MSG_process_set_property(msg_process_t, char* key, void* data)
390 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
391
392 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
393 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
394   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
395   //                              <100 si c'est pas CPU intensive)
396   // Contraintes à poser:
397   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
398   //   VM_coreAmount >= Load de toutes les tasks
399 */
400
401   /*
402 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
403 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
404 + des fonctions de filtrage sur les dynar
405 */
406 #include "instr/instr.h"
407
408
409
410 /* ****************************************************************************************** */
411 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
412 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
413
414 /* ****************************************************************************************** */
415 /* TUTORIAL: New API                                                                        */
416 /* Declare all functions for the API                                                          */
417 /* ****************************************************************************************** */
418 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);
419
420 SG_END_DECL()
421 #endif