Logo AND Algorithmique Numérique Distribuée

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