Logo AND Algorithmique Numérique Distribuée

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