include/simgrid/msg.h

   1 /* Copyright (c) 2004-2015. 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 #include "xbt/lib.h"
  12 #include "simgrid/forward.h"
  13 #include "simgrid/simix.h"
  14 #include "simgrid/platf.h"
  15
  16 SG_BEGIN_DECL()
  17
  18 /* ******************************** Mailbox ************************************ */
  19
  20 /** @brief Mailbox datatype
  21  *  @ingroup msg_task_usage
  22  *
  23  * Object representing a communication rendez-vous point, on which
  24  * the sender finds the receiver it wants to communicate with. As a
  25  * MSG user, you will only rarely manipulate any of these objects
  26  * directly, since most of the public interface (such as
  27  * #MSG_task_send and friends) hide this object behind a string
  28  * alias. That mean that you don't provide the mailbox on which you
  29  * want to send your task, but only the name of this mailbox. */
  30 typedef struct s_smx_rvpoint *msg_mailbox_t;
  31
  32 /* ******************************** Environment ************************************ */
  33 typedef surf_As *msg_as_t;
  34
  35 /* ******************************** Host ************************************ */
  36
  37 /** @brief Host datatype.
  38     @ingroup m_host_management
  39
  40     A <em>location</em> (or <em>host</em>) is any possible place where
  41     a process may run. Thus it is represented as a <em>physical
  42     resource with computing capabilities</em>, some <em>mailboxes</em>
  43     to enable running process to communicate with remote ones, and
  44     some <em>private data</em> that can be only accessed by local
  45     process.
  46  */
  47 typedef sg_host_t msg_host_t;
  48
  49 typedef struct s_msg_host_priv {
  50   int        dp_enabled;
  51   xbt_dict_t dp_objs;
  52   double     dp_updated_by_deleted_tasks;
  53   int        is_migrating;
  54
  55   xbt_dict_t affinity_mask_db;
  56   xbt_dynar_t file_descriptor_table;
  57 } s_msg_host_priv_t;
  58
  59 /* ******************************** Task ************************************ */
  60
  61 typedef struct simdata_task *simdata_task_t;
  62
  63 typedef struct msg_task {
  64   char *name;                   /**< @brief task name if any */
  65   simdata_task_t simdata;       /**< @brief simulator data */
  66   void *data;                   /**< @brief user data */
  67   long long int counter;        /* task unique identifier for instrumentation */
  68   char *category;               /* task category for instrumentation */
  69 } s_msg_task_t;
  70
  71 /** @brief Task datatype.
  72     @ingroup m_task_management
  73
  74     A <em>task</em> may then be defined by a <em>computing
  75     amount</em>, a <em>message size</em> and some <em>private
  76     data</em>.
  77  */
  78 typedef struct msg_task *msg_task_t;
  79
  80 /* ******************************** VM ************************************* */
  81 typedef msg_host_t msg_vm_t;
  82
  83 /** ******************************** File ************************************ */
  84
  85 /** @brief File datatype.
  86 *  @ingroup msg_file_management
  87 *
  88 *  You should consider this as an opaque object.
  89 */
  90 typedef xbt_dictelm_t msg_file_t;
  91 typedef s_xbt_dictelm_t s_msg_file_t;
  92
  93 extern int MSG_FILE_LEVEL;
  94 typedef struct simdata_file *simdata_file_t;
  95
  96 typedef struct msg_file_priv  {
  97   char *fullpath;
  98   sg_size_t size;
  99   char* mount_point;
 100   char* storageId;
 101   char* storage_type;
 102   char* content_type;
 103   int desc_id;
 104   void *data;
 105   simdata_file_t simdata;
 106 } s_msg_file_priv_t, *msg_file_priv_t;
 107
 108 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
 109   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
 110 }
 111
 112 /* ******************************** Storage ************************************ */
 113 /* TODO: PV: to comment */
 114
 115 extern int MSG_STORAGE_LEVEL;
 116
 117 /** @brief Storage datatype.
 118  *  @ingroup msg_storage_management
 119  *
 120  *  You should consider this as an opaque object.
 121  */
 122 typedef xbt_dictelm_t msg_storage_t;
 123 typedef s_xbt_dictelm_t s_msg_storage_t;
 124
 125 typedef struct msg_storage_priv  {
 126   const char *hostname;
 127   void *data;
 128 } s_msg_storage_priv_t, *msg_storage_priv_t;
 129
 130 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
 131   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
 132 }
 133
 134 /*************** Begin GPU ***************/
 135 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 136
 137 typedef struct msg_gpu_task {
 138   char *name;                   /**< @brief task name if any */
 139   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 140   long long int counter;        /* task unique identifier for instrumentation */
 141   char *category;               /* task category for instrumentation */
 142 } s_msg_gpu_task_t;
 143
 144 /** @brief GPU task datatype.
 145     @ingroup m_task_management
 146
 147     A <em>task</em> may then be defined by a <em>computing
 148     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 149     \see m_task_management
 150 */
 151 typedef struct msg_gpu_task *msg_gpu_task_t;
 152 /*************** End GPU ***************/
 153
 154 /**
 155  * \brief @brief Communication action.
 156  * \ingroup msg_task_usage
 157  *
 158  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 159  */
 160 typedef struct msg_comm *msg_comm_t;
 161
 162 /** \brief Default value for an uninitialized #msg_task_t.
 163     \ingroup m_task_management
 164 */
 165 #define MSG_TASK_UNINITIALIZED NULL
 166
 167 /* ****************************** Process *********************************** */
 168
 169 /** @brief Process datatype.
 170     @ingroup m_process_management
 171
 172     A process may be defined as a <em>code</em>, with some
 173     <em>private data</em>, executing in a <em>location</em>.
 174
 175     You should not access directly to the fields of the pointed
 176     structure, but always use the provided API to interact with
 177     processes.
 178  */
 179 typedef struct s_smx_process *msg_process_t;
 180
 181 /** @brief Return code of most MSG functions
 182     @ingroup msg_simulation
 183     @{ */
 184 /* Keep these code as binary values: java bindings manipulate | of these values */
 185 typedef enum {
 186   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
 187   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
 188   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
 189       transfer. Either the network is down or the remote host has been
 190       shutdown. */
 191   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
 192       running has just been rebooted. Free your datastructures and
 193       return now !*/
 194   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 195 } msg_error_t;
 196 /** @} */
 197
 198 /************************** Global ******************************************/
 199 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
 200 /** \ingroup msg_simulation
 201  *  \brief Initialize the MSG internal data.
 202  *  \hideinitializer
 203  *
 204  *  It also check that the link-time and compile-time versions of SimGrid do
 205  *  match, so you should use this version instead of the #MSG_init_nocheck
 206  *  function that does the same initializations, but without this check.
 207  *
 208  *  We allow to link against compiled versions that differ in the patch level.
 209  */
 210 #define MSG_init(argc,argv)  do {                                                          \
 211   sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
 212     MSG_init_nocheck(argc,argv);                                                        \
 213   } while (0)
 214
 215 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
 216 XBT_PUBLIC(msg_error_t) MSG_main(void);
 217 XBT_PUBLIC(void) MSG_function_register(const char *name,
 218                                        xbt_main_func_t code);
 219 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
 220 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
 221 XBT_PUBLIC(void) MSG_launch_application(const char *file);
 222 /*Bypass the parser */
 223 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
 224                                   const char *function_name,
 225                                   xbt_dynar_t arguments);
 226
 227 XBT_PUBLIC(double) MSG_get_clock(void);
 228 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
 229
 230 /************************** Environment ***********************************/
 231 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
 232 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
 233 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
 234 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
 235 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
 236 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
 237 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
 238
 239 /************************** File handling ***********************************/
 240 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
 241 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
 242 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
 243 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
 244 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
 245 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
 246 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
 247 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
 248 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
 249 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
 250 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
 251 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
 252 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
 253 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
 254 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
 255 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
 256 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
 257 /************************** Storage handling ***********************************/
 258 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
 259 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
 260 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
 261 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
 262 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
 263 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
 264 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
 265 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
 266 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
 267 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
 268 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
 269 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
 270 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
 271 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
 272 /************************** AS Router handling ************************************/
 273 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
 274 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
 275 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
 276
 277 /************************** Host handling ***********************************/
 278 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
 279 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
 280 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
 281 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 282 /** \ingroup m_host_management
 283  *
 284  * \brief Return the name of the #msg_host_t. */
 285 #define MSG_host_get_name(host) sg_host_get_name(host)
 286 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
 287 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
 288 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
 289 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
 290 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 291 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
 292 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
 293 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
 294
 295 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
 296 XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h);
 297 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
 298 #define MSG_host_get_pstate(h)         sg_host_get_pstate(h)
 299 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate)
 300 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
 301 XBT_PUBLIC(int) MSG_get_host_number(void);
 302 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, vm_params_t params);
 303 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, vm_params_t params);
 304 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
 305 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
 306 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
 307
 308 /*property handlers*/
 309 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
 310 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
 311                                                      const char *name);
 312 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
 313                                              const char *name, char *value,
 314                                              void_f_pvoid_t free_ctn);
 315
 316
 317 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 318
 319 /************************** Process handling *********************************/
 320 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
 321                                            xbt_main_func_t code,
 322                                            void *data, msg_host_t host);
 323 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
 324                                                           xbt_main_func_t
 325                                                           code, void *data,
 326                                                           msg_host_t host,
 327                                                           int argc,
 328                                                           char **argv);
 329 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
 330                                                             *name,
 331                                                             xbt_main_func_t
 332                                                             code,
 333                                                             void *data,
 334                                                             msg_host_t host,
 335                                                             int argc,
 336                                                             char **argv,
 337                                                             xbt_dict_t
 338                                                             properties);
 339 XBT_PUBLIC(msg_process_t) MSG_process_attach(
 340   const char *name, void *data,
 341   msg_host_t host, xbt_dict_t properties);
 342 XBT_PUBLIC(void) MSG_process_detach(void);
 343
 344 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
 345 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 346 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
 347
 348 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
 349 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
 350                                              void *data);
 351 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 352 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
 353 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
 354 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
 355 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
 356 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
 357 XBT_PUBLIC(int) MSG_process_self_PID(void);
 358 XBT_PUBLIC(int) MSG_process_self_PPID(void);
 359 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
 360 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
 361 XBT_PUBLIC(int) MSG_process_get_number(void);
 362
 363 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
 364
 365 /*property handlers*/
 366 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
 367 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
 368                                                         process,
 369                                                         const char *name);
 370
 371 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
 372 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
 373 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
 374 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
 375 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 376
 377 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
 378
 379 /************************** Task handling ************************************/
 380 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
 381                                      double flops_amount,
 382                                      double bytes_amount, void *data);
 383 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
 384                                      double flops_amount,
 385                                      double dispatch_latency,
 386                                      double collect_latency);
 387 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
 388                                               int host_nb,
 389                                               const msg_host_t * host_list,
 390                                               double *flops_amount,
 391                                               double *bytes_amount,
 392                                               void *data);
 393 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
 394 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
 395 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
 396     msg_task_t task, msg_process_t src, msg_process_t dst));
 397 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
 398 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
 399 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
 400 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
 401 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
 402 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
 403
 404 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
 405 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
 406 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
 407 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
 408 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
 409
 410 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
 411 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 412
 413 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
 414                                                double flops_amount);
 415 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
 416 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
 417                                         double bytes_amount);
 418
 419 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
 420 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 421 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
 422
 423
 424 XBT_PUBLIC(msg_error_t)
 425     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
 426                      msg_host_t host);
 427
 428 XBT_PUBLIC(msg_error_t)
 429     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
 430                               double timeout);
 431
 432 XBT_PUBLIC(msg_error_t)
 433     MSG_task_receive(msg_task_t * task, const char *alias);
 434 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 435
 436
 437
 438 XBT_PUBLIC(msg_error_t)
 439     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
 440                      msg_host_t host, double rate);
 441
 442 XBT_PUBLIC(msg_error_t)
 443     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
 444                               double timeout, double rate);
 445
 446 XBT_PUBLIC(msg_error_t)
 447     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
 448 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
 449
 450 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
 451 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
 452 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
 453                                                     const char *alias,
 454                                                     int (*match_fun)(void*,void*, smx_synchro_t),
 455                                                     void *match_data);
 456
 457 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
 458 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
 459 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
 460 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
 461 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
 462 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 463 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 464 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 465 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
 466                                   double timeout);
 467 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 468 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
 469 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
 470
 471 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 472
 473 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
 474                                           msg_host_t host);
 475
 476 XBT_PUBLIC(msg_error_t)
 477     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
 478                            double timeout);
 479
 480 XBT_PUBLIC(msg_error_t)
 481     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
 482                            double timeout, double maxrate);
 483
 484 XBT_PUBLIC(msg_error_t)
 485     MSG_task_send(msg_task_t task, const char *alias);
 486
 487 XBT_PUBLIC(msg_error_t)
 488     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
 489
 490 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 491
 492 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 493 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 494
 495 /************************** Task handling ************************************/
 496 XBT_PUBLIC(msg_error_t)
 497     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
 498                          msg_host_t host, double timeout);
 499
 500 XBT_PUBLIC(msg_error_t)
 501     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
 502                                      msg_host_t host, double timeout, double rate);
 503
 504 XBT_PUBLIC(msg_error_t)
 505     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
 506                              double timeout);
 507
 508 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
 509
 510
 511 /************************** Action handling **********************************/
 512 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 513 XBT_PUBLIC(void) MSG_action_init(void);
 514 XBT_PUBLIC(void) MSG_action_exit(void);
 515
 516 /** @brief Opaque type representing a semaphore
 517  *  @ingroup msg_synchro
 518  *  @hideinitializer
 519  */
 520 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
 521 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
 522 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
 523 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 524 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
 525 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
 526 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
 527 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
 528
 529 /** @brief Opaque type representing a barrier identifier
 530  *  @ingroup msg_synchro
 531  *  @hideinitializer
 532  */
 533
 534 #define MSG_BARRIER_SERIAL_PROCESS -1
 535 typedef struct s_xbt_bar *msg_bar_t;
 536 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
 537 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
 538 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
 539
 540 /** @brief Opaque type describing a Virtual Machine.
 541  *  @ingroup msg_VMs
 542  *
 543  * All this is highly experimental and the interface will probably change in the future.
 544  * Please don't depend on this yet (although testing is welcomed if you feel so).
 545  * Usual lack of guaranty of any kind applies here, and is even increased.
 546  *
 547  */
 548
 549 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
 550 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
 551 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
 552
 553 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
 554 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
 555 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
 556 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
 557
 558
 559 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
 560
 561 // TODO add VDI later
 562 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
 563 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
 564     int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
 565
 566 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 567
 568 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
 569
 570 /* Shutdown the guest operating system. */
 571 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
 572
 573 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
 574
 575 /* Suspend the execution of the VM, but keep its state on memory. */
 576 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
 577 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
 578
 579 /* Save the VM state to a disk. */
 580 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
 581 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
 582
 583 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
 584 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
 585 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
 586
 587 /* TODO: do we need this? */
 588 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
 589
 590 /*
 591 void* MSG_process_get_property(msg_process_t, char* key)
 592 void MSG_process_set_property(msg_process_t, char* key, void* data)
 593 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
 594
 595 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
 596 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
 597   // inducedLoad: a percentage (>100 if it loads more than one core;
 598   //                            <100 if it's not CPU intensive)
 599   // Required contraints:
 600   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
 601   //   VM_coreAmount >= Load of all tasks
 602 */
 603
 604   /*
 605 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
 606 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
 607 + filtering functions on dynars
 608 */
 609 #include "simgrid/instr.h"
 610
 611
 612
 613 /* ****************************************************************************************** */
 614 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 615 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 616
 617 SG_END_DECL()
 618 #endif