Logo AND Algorithmique Numérique Distribuée

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