Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the 'TUTORIAL: New API' chunks
[simgrid.git] / include / msg / msg.h
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef MSG_H
8 #define MSG_H
9
10 #include "xbt.h"
11
12 #include "msg/datatypes.h"
13
14 #include "simgrid/simix.h"
15
16 #include "simgrid/platf.h"
17
18 SG_BEGIN_DECL()
19
20 /** @brief Return code of most MSG functions
21     @ingroup msg_simulation
22     @{ */
23 /* Keep these code as binary values: java bindings manipulate | of these values */
24 typedef enum {
25   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
26   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
27   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
28       transfer. Either the network is down or the remote host has been
29       shutdown. */
30   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
31       running has just been rebooted. Free your datastructures and
32       return now !*/
33   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
34 } msg_error_t;
35 /** @} */
36
37 /************************** Global ******************************************/
38 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
39 /** \ingroup msg_simulation
40  *  \brief Initialize the MSG internal data.
41  *  \hideinitializer
42  *
43  *  It also check that the link-time and compile-time versions of SimGrid do
44  *  match, so you should use this version instead of the #MSG_init_nocheck
45  *  function that does the same initializations, but without this check.
46  *
47  *  We allow to link against compiled versions that differ in the patch level.
48  */
49 #define MSG_init(argc,argv)  {                                          \
50     int ver_major,ver_minor,ver_patch;                                  \
51     sg_version(&ver_major,&ver_minor,&ver_patch);                       \
52     if ((ver_major != SIMGRID_VERSION_MAJOR) ||                         \
53         (ver_minor != SIMGRID_VERSION_MINOR)) {                         \
54       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", \
55               SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch); \
56     }                                                                   \
57     MSG_init_nocheck(argc,argv);                                        \
58   }
59
60 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
61 XBT_PUBLIC(msg_error_t) MSG_main(void);
62 XBT_PUBLIC(void) MSG_function_register(const char *name,
63                                        xbt_main_func_t code);
64 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
65 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
66 XBT_PUBLIC(void) MSG_launch_application(const char *file);
67 /*Bypass the parser */
68 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
69                                   const char *function_name,
70                                   xbt_dynar_t arguments);
71
72 XBT_PUBLIC(double) MSG_get_clock(void);
73 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
74
75 /************************** Environment ***********************************/
76 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
77 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
78 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
79 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
80 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
81 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
82 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
83
84 /************************** File handling ***********************************/
85 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
86 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
87 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
88 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
89 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
90 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
91 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
92 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
93 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
94 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
95 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
96 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
97 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
98 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t storage);
99 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
100 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
101 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
102 /************************** Storage handling ***********************************/
103 XBT_PUBLIC(msg_host_t) MSG_get_storage_by_name(const char *name);
104 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
105 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
106 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
107 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
108 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
109 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
110 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
111 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
112 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
113 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
114 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
115 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
116 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
117 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
118 /************************** AS Router handling ************************************/
119 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
120 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
121 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
122
123 /************************** Host handling ***********************************/
124 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
125 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
126 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
127 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
128 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
129 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
130 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
131 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
132 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
133 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
134 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
135 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
136 XBT_PUBLIC(void) __MSG_host_priv_free(msg_host_priv_t priv);
137 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
138
139 XBT_PUBLIC(double) MSG_get_host_power_peak_at(msg_host_t h, int pstate_index);
140 XBT_PUBLIC(double) MSG_get_host_current_power_peak(msg_host_t h);
141 XBT_PUBLIC(int) MSG_get_host_nb_pstates(msg_host_t h);
142 XBT_PUBLIC(void) MSG_set_host_power_peak_at(msg_host_t h, int pstate);
143 XBT_PUBLIC(double) MSG_get_host_consumed_energy(msg_host_t h);
144
145 /*property handlers*/
146 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
147 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
148                                                      const char *name);
149 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
150                                              const char *name, char *value,
151                                              void_f_pvoid_t free_ctn);
152
153
154 XBT_PUBLIC(void) MSG_create_environment(const char *file);
155
156 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
157 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
158 XBT_PUBLIC(int) MSG_get_host_number(void);
159 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, ws_params_t params);
160 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, ws_params_t params);
161 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
162 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
163 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
164 /************************** Process handling *********************************/
165 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
166                                            xbt_main_func_t code,
167                                            void *data, msg_host_t host);
168 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
169                                                           xbt_main_func_t
170                                                           code, void *data,
171                                                           msg_host_t host,
172                                                           int argc,
173                                                           char **argv);
174 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
175                                                             *name,
176                                                             xbt_main_func_t
177                                                             code,
178                                                             void *data,
179                                                             msg_host_t host,
180                                                             int argc,
181                                                             char **argv,
182                                                             xbt_dict_t
183                                                             properties);
184 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
185 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
186 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
187
188 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
189 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
190                                              void *data);
191 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
192 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
193 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
194 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
195 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
196 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
197 XBT_PUBLIC(int) MSG_process_self_PID(void);
198 XBT_PUBLIC(int) MSG_process_self_PPID(void);
199 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
200 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
201 XBT_PUBLIC(int) MSG_process_get_number(void);
202
203 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
204
205 /*property handlers*/
206 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
207 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
208                                                         process,
209                                                         const char *name);
210
211 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
212 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
213 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
214 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
215 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
216
217 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
218
219 /************************** Task handling ************************************/
220 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
221                                      double compute_duration,
222                                      double message_size, void *data);
223 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
224                                      double compute_duration,
225                                      double dispatch_latency,
226                                      double collect_latency);
227 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
228                                               int host_nb,
229                                               const msg_host_t * host_list,
230                                               double *computation_amount,
231                                               double *communication_amount,
232                                               void *data);
233 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
234 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
235 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
236     msg_task_t task, msg_process_t src, msg_process_t dst));
237 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
238 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
239 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
240 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
241 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
242 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
243
244 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
245                                        msg_host_t host);
246 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
247                                        msg_host_t host, double rate);
248
249 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
250 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
251 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
252 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
253 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
254
255 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
256 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
257
258 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
259 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
260                                                double compute_duration);
261 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
262                                         double data_size);
263
264 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
265 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
266 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
267 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
268
269
270 XBT_PUBLIC(msg_error_t)
271     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
272                      msg_host_t host);
273
274 XBT_PUBLIC(msg_error_t)
275     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
276                               double timeout);
277
278 XBT_PUBLIC(msg_error_t)
279     MSG_task_receive(msg_task_t * task, const char *alias);
280 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
281
282
283
284 XBT_PUBLIC(msg_error_t)
285     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
286                      msg_host_t host, double rate);
287
288 XBT_PUBLIC(msg_error_t)
289     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
290                               double timeout, double rate);
291
292 XBT_PUBLIC(msg_error_t)
293     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
294 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
295
296 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
297 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
298 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
299                                                     const char *alias,
300                                                     int (*match_fun)(void*,void*, smx_action_t),
301                                                     void *match_data);
302
303 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
304 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
305 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
306 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
307 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
308 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
309 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
310 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
311 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
312                                   double timeout);
313 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
314 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
315 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
316
317 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
318
319 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
320                                           msg_host_t host);
321
322 XBT_PUBLIC(msg_error_t)
323     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
324                            double timeout);
325
326 XBT_PUBLIC(msg_error_t)
327     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
328                            double timeout, double maxrate);
329
330 XBT_PUBLIC(msg_error_t)
331     MSG_task_send(msg_task_t task, const char *alias);
332
333 XBT_PUBLIC(msg_error_t)
334     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
335
336 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
337
338 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
339 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
340
341 /************************** Task handling ************************************/
342 XBT_PUBLIC(msg_error_t)
343     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
344                          msg_host_t host, double timeout);
345
346 XBT_PUBLIC(msg_error_t)
347     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
348                                      msg_host_t host, double timeout, double rate);
349
350 XBT_PUBLIC(msg_error_t)
351     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
352                              double timeout);
353
354 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
355
356
357 /************************** Action handling **********************************/
358 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
359 XBT_PUBLIC(void) MSG_action_init(void);
360 XBT_PUBLIC(void) MSG_action_exit(void);
361
362 #ifdef MSG_USE_DEPRECATED
363
364 typedef msg_error_t MSG_error_t;
365
366 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
367 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
368
369 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
370 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
371
372 #define MSG_host_is_avail(h) MSG_host_is_on(h)
373
374 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
375 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
376 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
377         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
378
379 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
380 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
381
382 XBT_PUBLIC(msg_error_t) MSG_clean(void);
383
384 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
385 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
386                                                   m_channel_t channel,
387                                                   double max_duration);
388 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
389                                                int channel, msg_host_t host);
390 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
391                                          double max_duration,
392                                          msg_host_t host);
393 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
394                                      m_channel_t channel);
395 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
396                                              msg_host_t dest,
397                                              m_channel_t channel,
398                                              double max_rate);
399 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
400                                                   msg_host_t dest,
401                                                   m_channel_t channel,
402                                                   double max_duration);
403 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
404 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
405 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
406
407 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
408 XBT_PUBLIC(int) MSG_get_channel_number(void);
409 #endif
410
411 /** @brief Opaque type representing a semaphore
412  *  @ingroup msg_synchro
413  *  @hideinitializer
414  */
415 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
416 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
417 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
418 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
419 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
420 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
421 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
422 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
423
424 /** @brief Opaque type representing a barrier identifier
425  *  @ingroup msg_synchro
426  *  @hideinitializer
427  */
428
429 #define MSG_BARRIER_SERIAL_PROCESS -1
430 typedef struct s_xbt_bar *msg_bar_t;
431 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
432 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
433 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
434
435 /** @brief Opaque type describing a Virtual Machine.
436  *  @ingroup msg_VMs
437  *
438  * All this is highly experimental and the interface will probably change in the future.
439  * Please don't depend on this yet (although testing is welcomed if you feel so).
440  * Usual lack of guaranty of any kind applies here, and is even increased.
441  *
442  */
443
444 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
445 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
446 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
447
448 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
449 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
450 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
451 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
452
453
454 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
455
456 // TODO add VDI later
457 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
458 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
459     int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
460
461 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
462
463 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
464
465 /* Shutdown the guest operating system. */
466 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
467
468 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
469
470 /* Suspend the execution of the VM, but keep its state on memory. */
471 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
472 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
473
474 /* Save the VM state to a disk. */
475 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
476 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
477
478 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
479 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
480 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
481
482 /* TODO: do we need this? */
483 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
484
485 /*
486 void* MSG_process_get_property(msg_process_t, char* key)
487 void MSG_process_set_property(msg_process_t, char* key, void* data)
488 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
489
490 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
491 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
492   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
493   //                              <100 si c'est pas CPU intensive)
494   // Contraintes à poser:
495   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
496   //   VM_coreAmount >= Load de toutes les tasks
497 */
498
499   /*
500 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
501 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
502 + des fonctions de filtrage sur les dynar
503 */
504 #include "instr/instr.h"
505
506
507
508 /* ****************************************************************************************** */
509 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
510 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
511
512 SG_END_DECL()
513 #endif