Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
14da99662013f08098d3dc0b9e663ecee7636207
[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(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
79 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
80 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
81 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
82
83 /************************** File handling ***********************************/
84 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
85 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
86 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
87 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
88 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
89 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
90 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
91 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
92 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
93 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_size_t offset, int origin);
94 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
95 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
96 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
97 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t storage);
98 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
99 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
100 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
101 /************************** Storage handling ***********************************/
102 XBT_PUBLIC(msg_host_t) MSG_get_storage_by_name(const char *name);
103 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
104 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
105 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
106 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
107 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
108 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
109 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
110 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
111 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
112 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
113 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
114 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
115 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
116 /************************** AS Router handling ************************************/
117 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
118 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
119 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
120
121 /************************** Host handling ***********************************/
122 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
123 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
124 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
125 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
126 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
127 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
128 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
129 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
130 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
131 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
132 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
133 XBT_PUBLIC(void) __MSG_host_priv_free(msg_host_priv_t priv);
134 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
135
136 XBT_PUBLIC(double) MSG_get_host_power_peak_at(msg_host_t h, int pstate_index);
137 XBT_PUBLIC(double) MSG_get_host_current_power_peak(msg_host_t h);
138 XBT_PUBLIC(int) MSG_get_host_nb_pstates(msg_host_t h);
139 XBT_PUBLIC(void) MSG_set_host_power_peak_at(msg_host_t h, int pstate);
140 XBT_PUBLIC(double) MSG_get_host_consumed_energy(msg_host_t h);
141
142 /*property handlers*/
143 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
144 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
145                                                      const char *name);
146 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
147                                              const char *name, char *value,
148                                              void_f_pvoid_t free_ctn);
149
150
151 XBT_PUBLIC(void) MSG_create_environment(const char *file);
152
153 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
154 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
155 XBT_PUBLIC(int) MSG_get_host_number(void);
156 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, ws_params_t params);
157 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, ws_params_t params);
158 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
159 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
160 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
161 /************************** Process handling *********************************/
162 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
163                                            xbt_main_func_t code,
164                                            void *data, msg_host_t host);
165 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
166                                                           xbt_main_func_t
167                                                           code, void *data,
168                                                           msg_host_t host,
169                                                           int argc,
170                                                           char **argv);
171 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
172                                                             *name,
173                                                             xbt_main_func_t
174                                                             code,
175                                                             void *data,
176                                                             msg_host_t host,
177                                                             int argc,
178                                                             char **argv,
179                                                             xbt_dict_t
180                                                             properties);
181 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
182 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
183
184 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
185
186 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
187 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
188                                              void *data);
189 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
190 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
191 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
192 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
193 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
194 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
195 XBT_PUBLIC(int) MSG_process_self_PID(void);
196 XBT_PUBLIC(int) MSG_process_self_PPID(void);
197 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
198 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
199 XBT_PUBLIC(int) MSG_process_get_number(void);
200
201 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
202
203 /*property handlers*/
204 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
205 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
206                                                         process,
207                                                         const char *name);
208
209 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
210 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
211 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
212 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
213 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
214
215 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
216
217 /************************** Task handling ************************************/
218 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
219                                      double compute_duration,
220                                      double message_size, void *data);
221 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
222                                      double compute_duration,
223                                      double dispatch_latency,
224                                      double collect_latency);
225 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
226                                               int host_nb,
227                                               const msg_host_t * host_list,
228                                               double *computation_amount,
229                                               double *communication_amount,
230                                               void *data);
231 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
232 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
233 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
234     msg_task_t task, msg_process_t src, msg_process_t dst));
235 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
236 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
237 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
238 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
239 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
240 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
241
242 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
243                                        msg_host_t host);
244 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
245                                        msg_host_t host, double rate);
246
247 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
248 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
249 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
250 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
251 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
252
253 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
254
255 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
256 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
257                                                double compute_duration);
258 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
259                                         double data_size);
260
261 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
262 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
263 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
264 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
265
266
267 XBT_PUBLIC(msg_error_t)
268     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
269                      msg_host_t host);
270
271 XBT_PUBLIC(msg_error_t)
272     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
273                               double timeout);
274
275 XBT_PUBLIC(msg_error_t)
276     MSG_task_receive(msg_task_t * task, const char *alias);
277 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
278
279
280
281 XBT_PUBLIC(msg_error_t)
282     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
283                      msg_host_t host, double rate);
284
285 XBT_PUBLIC(msg_error_t)
286     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
287                               double timeout, double rate);
288
289 XBT_PUBLIC(msg_error_t)
290     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
291 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
292
293 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
294 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
295 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
296                                                     const char *alias,
297                                                     int (*match_fun)(void*,void*, smx_action_t),
298                                                     void *match_data);
299
300 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
301 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
302 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
303 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
304 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
305 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
306 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
307 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
308 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
309                                   double timeout);
310 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
311 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
312 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
313
314 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
315
316 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
317                                           msg_host_t host);
318
319 XBT_PUBLIC(msg_error_t)
320     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
321                            double timeout);
322
323 XBT_PUBLIC(msg_error_t)
324     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
325                            double timeout, double maxrate);
326
327 XBT_PUBLIC(msg_error_t)
328     MSG_task_send(msg_task_t task, const char *alias);
329
330 XBT_PUBLIC(msg_error_t)
331     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
332
333 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
334
335 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
336 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
337
338 /************************** Task handling ************************************/
339 XBT_PUBLIC(msg_error_t)
340     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
341                          msg_host_t host, double timeout);
342
343 XBT_PUBLIC(msg_error_t)
344     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
345                                      msg_host_t host, double timeout, double rate);
346
347 XBT_PUBLIC(msg_error_t)
348     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
349                              double timeout);
350
351 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
352
353
354 /************************** Action handling **********************************/
355 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
356
357 #ifdef MSG_USE_DEPRECATED
358
359 typedef msg_error_t MSG_error_t;
360
361 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
362 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
363
364 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
365 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
366
367 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
368 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
369 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
370         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
371
372 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
373 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
374
375 XBT_PUBLIC(msg_error_t) MSG_clean(void);
376
377 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
378 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
379                                                   m_channel_t channel,
380                                                   double max_duration);
381 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
382                                                int channel, msg_host_t host);
383 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
384                                          double max_duration,
385                                          msg_host_t host);
386 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
387                                      m_channel_t channel);
388 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
389                                              msg_host_t dest,
390                                              m_channel_t channel,
391                                              double max_rate);
392 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
393                                                   msg_host_t dest,
394                                                   m_channel_t channel,
395                                                   double max_duration);
396 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
397 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
398 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
399
400 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
401 XBT_PUBLIC(int) MSG_get_channel_number(void);
402 #endif
403
404 /** @brief Opaque type representing a semaphore
405  *  @ingroup msg_synchro
406  *  @hideinitializer
407  */
408 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
409 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
410 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
411 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
412 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
413 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
414 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
415 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
416
417 /** @brief Opaque type describing a Virtual Machine.
418  *  @ingroup msg_VMs
419  *
420  * All this is highly experimental and the interface will probably change in the future.
421  * Please don't depend on this yet (although testing is welcomed if you feel so).
422  * Usual lack of guaranty of any kind applies here, and is even increased.
423  *
424  */
425
426 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
427 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
428 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
429
430 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
431 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
432 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
433 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
434
435
436 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
437
438 // TODO add VDI later
439 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
440 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
441     int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
442
443 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
444
445 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
446
447 /* Shutdown the guest operating system. */
448 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
449
450 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
451
452 /* Suspend the execution of the VM, but keep its state on memory. */
453 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
454 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
455
456 /* Save the VM state to a disk. */
457 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
458 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
459
460 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
461 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
462 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
463
464 /* TODO: do we need this? */
465 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
466
467 /*
468 void* MSG_process_get_property(msg_process_t, char* key)
469 void MSG_process_set_property(msg_process_t, char* key, void* data)
470 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
471
472 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
473 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
474   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
475   //                              <100 si c'est pas CPU intensive)
476   // Contraintes à poser:
477   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
478   //   VM_coreAmount >= Load de toutes les tasks
479 */
480
481   /*
482 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
483 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
484 + des fonctions de filtrage sur les dynar
485 */
486 #include "instr/instr.h"
487
488
489
490 /* ****************************************************************************************** */
491 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
492 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
493
494 /* ****************************************************************************************** */
495 /* TUTORIAL: New API                                                                        */
496 /* Declare all functions for the API                                                          */
497 /* ****************************************************************************************** */
498 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);
499
500 SG_END_DECL()
501 #endif