include/msg/msg.h

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