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
  15 SG_BEGIN_DECL()
  16
  17 /* *************************** Network Zones ******************************** */
  18 #define msg_as_t msg_netzone_t /* portability macro */
  19 typedef s4u_NetZone* msg_netzone_t;
  20
  21 /* ******************************** Host ************************************ */
  22
  23 /** @brief Host datatype.
  24     @ingroup m_host_management
  25
  26     A <em>location</em> (or <em>host</em>) is any possible place where
  27     a process may run. Thus it is represented as a <em>physical
  28     resource with computing capabilities</em>, some <em>mailboxes</em>
  29     to enable running process to communicate with remote ones, and
  30     some <em>private data</em> that can be only accessed by local
  31     process.
  32  */
  33 typedef sg_host_t msg_host_t;
  34
  35
  36 XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
  37 /* ******************************** Task ************************************ */
  38
  39 typedef struct simdata_task *simdata_task_t;
  40
  41 typedef struct msg_task {
  42   char *name;                   /**< @brief task name if any */
  43   simdata_task_t simdata;       /**< @brief simulator data */
  44   void *data;                   /**< @brief user data */
  45   long long int counter;        /* task unique identifier for instrumentation */
  46   char *category;               /* task category for instrumentation */
  47 } s_msg_task_t;
  48
  49 /** @brief Task datatype.
  50     @ingroup m_task_management
  51
  52     A <em>task</em> may then be defined by a <em>computing
  53     amount</em>, a <em>message size</em> and some <em>private
  54     data</em>.
  55  */
  56 typedef struct msg_task *msg_task_t;
  57
  58 /* ******************************** VM ************************************* */
  59 typedef msg_host_t msg_vm_t;
  60
  61 /* ******************************** File ************************************ */
  62
  63 typedef struct simdata_file* simdata_file_t;
  64
  65 typedef struct msg_file_priv {
  66   char *fullpath;
  67   sg_size_t size;
  68   char* mount_point;
  69   char* storageId;
  70   char* storage_type;
  71   char* content_type;
  72   int desc_id;
  73   void *data;
  74   simdata_file_t simdata;
  75 } s_msg_file_priv_t;
  76
  77 typedef struct msg_file_priv* msg_file_t;
  78
  79 /* ******************************** Storage ************************************ */
  80 /* TODO: PV: to comment */
  81
  82 extern int MSG_STORAGE_LEVEL;
  83
  84 /** @brief Storage datatype.
  85  *  @ingroup msg_storage_management
  86  *
  87  *  You should consider this as an opaque object.
  88  */
  89 typedef xbt_dictelm_t msg_storage_t;
  90
  91 struct msg_storage_priv  {
  92   const char* name;
  93   const char* hostname;
  94   sg_size_t size;
  95   void* data;
  96 };
  97 typedef struct msg_storage_priv  s_msg_storage_priv_t;
  98 typedef struct msg_storage_priv* msg_storage_priv_t;
  99
 100 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
 101   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
 102 }
 103
 104 /**
 105  * \brief @brief Communication action.
 106  * \ingroup msg_task_usage
 107  *
 108  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 109  */
 110 typedef struct msg_comm *msg_comm_t;
 111
 112 /** \brief Default value for an uninitialized #msg_task_t.
 113     \ingroup m_task_management
 114 */
 115 #define MSG_TASK_UNINITIALIZED NULL
 116
 117 /* ****************************** Process *********************************** */
 118
 119 /** @brief Process datatype.
 120     @ingroup m_process_management
 121
 122     A process may be defined as a <em>code</em>, with some
 123     <em>private data</em>, executing in a <em>location</em>.
 124
 125     You should not access directly to the fields of the pointed
 126     structure, but always use the provided API to interact with
 127     processes.
 128  */
 129 typedef s4u_Actor* msg_process_t;
 130
 131 /** @brief Return code of most MSG functions
 132     @ingroup msg_simulation
 133     @{ */
 134 /* Keep these code as binary values: java bindings manipulate | of these values */
 135 typedef enum {
 136   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
 137   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
 138   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
 139       transfer. Either the network is down or the remote host has been
 140       shutdown. */
 141   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
 142       running has just been rebooted. Free your datastructures and
 143       return now !*/
 144   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 145 } msg_error_t;
 146 /** @} */
 147
 148 /************************** Global ******************************************/
 149 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
 150 /** \ingroup msg_simulation
 151  *  \brief Initialize the MSG internal data.
 152  *  \hideinitializer
 153  *
 154  *  It also check that the link-time and compile-time versions of SimGrid do
 155  *  match, so you should use this version instead of the #MSG_init_nocheck
 156  *  function that does the same initializations, but without this check.
 157  *
 158  *  We allow to link against compiled versions that differ in the patch level.
 159  */
 160 #define MSG_init(argc,argv)  do {                                                          \
 161   sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
 162     MSG_init_nocheck(argc,argv);                                                        \
 163   } while (0)
 164
 165 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
 166 XBT_PUBLIC(msg_error_t) MSG_main();;
 167 XBT_PUBLIC(void) MSG_function_register(const char *name,
 168                                        xbt_main_func_t code);
 169 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
 170 XBT_PUBLIC(void) MSG_launch_application(const char *file);
 171 /*Bypass the parser */
 172 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
 173                                   const char *function_name,
 174                                   xbt_dynar_t arguments);
 175
 176 XBT_PUBLIC(double) MSG_get_clock();
 177 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg();
 178
 179 /************************** Net Zones ***********************************/
 180 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_root();
 181 XBT_PUBLIC(const char*) MSG_zone_get_name(msg_netzone_t zone);
 182 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_by_name(const char* name);
 183 XBT_PUBLIC(void) MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
 184 XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char* name);
 185 XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
 186 XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
 187
 188 /* Deprecated forms of the previous functions */
 189 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_root since v3.16")
 190     msg_netzone_t MSG_environment_get_routing_root() {
 191   return MSG_zone_get_root();
 192 }
 193 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_name since v3.16")
 194     const char* MSG_environment_as_get_name(msg_netzone_t zone) {
 195   return MSG_zone_get_name(zone);
 196 }
 197 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_by_name since v3.16")
 198     msg_netzone_t MSG_environment_as_get_by_name(const char* name) {
 199   return MSG_zone_get_by_name(name);
 200 }
 201 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_sons since v3.16")
 202     xbt_dict_t MSG_environment_as_get_routing_sons(msg_netzone_t zone) {
 203   xbt_dict_t res = xbt_dict_new_homogeneous(NULL);
 204   MSG_zone_get_sons(zone, res);
 205   return res;
 206 }
 207 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_property_value since v3.16")
 208     const char* MSG_environment_as_get_property_value(msg_netzone_t zone, const char* name) {
 209   return MSG_zone_get_property_value(zone, name);
 210 }
 211 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_set_property_value since v3.16")
 212     void MSG_environment_as_set_property_value(msg_netzone_t zone, const char* name, char* value) {
 213   MSG_zone_set_property_value(zone, name, value);
 214 }
 215 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_hosts since v3.16")
 216     xbt_dynar_t MSG_environment_as_get_hosts(msg_netzone_t zone) {
 217   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
 218   MSG_zone_get_hosts(zone, res);
 219   return res;
 220 }
 221
 222 /************************** File handling ***********************************/
 223 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
 224 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
 225 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
 226 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
 227 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
 228 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
 229 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
 230 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
 231 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
 232 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
 233 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
 234 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
 235 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
 236 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
 237 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
 238 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
 239 /************************** Storage handling ***********************************/
 240 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
 241 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
 242 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
 243 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
 244 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
 245 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
 246 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
 247 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
 248 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
 249 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
 250 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
 251 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
 252 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
 253
 254 /************************** Host handling ***********************************/
 255 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
 256 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
 257 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
 258 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 259 /** \ingroup m_host_management
 260  *
 261  * \brief Return the name of the #msg_host_t. */
 262 #define MSG_host_get_name(host) sg_host_get_name(host)
 263 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
 264 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
 265 XBT_PUBLIC(msg_host_t) MSG_host_self();
 266 XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
 267 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 268 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
 269 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
 270 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
 271
 272 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h); /* deprecated */
 273
 274 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
 275 #define MSG_host_get_current_power_peak(h) MSG_host_get_speed(h) /* deprecated */
 276 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
 277 #define MSG_host_get_pstate(h)         sg_host_get_pstate(h)         /* deprecated */
 278 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* deprecated */
 279 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
 280 XBT_PUBLIC(int) MSG_get_host_number();
 281 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
 282 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
 283 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
 284
 285 /*property handlers*/
 286 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
 287 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
 288                                                      const char *name);
 289 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
 290
 291 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 292
 293 /************************** Process handling *********************************/
 294 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
 295                                            xbt_main_func_t code,
 296                                            void *data, msg_host_t host);
 297 XBT_PUBLIC(msg_process_t)
 298 MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
 299                                   char** argv);
 300 XBT_PUBLIC(msg_process_t)
 301 MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
 302                                     char** argv, xbt_dict_t properties);
 303
 304 XBT_PUBLIC(msg_process_t) MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
 305 XBT_PUBLIC(void) MSG_process_detach();
 306
 307 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
 308 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 309 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
 310 XBT_PUBLIC(void) MSG_process_yield();
 311
 312 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
 313 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
 314                                              void *data);
 315 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 316 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
 317 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
 318 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
 319 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
 320 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
 321 XBT_PUBLIC(int) MSG_process_self_PID();
 322 XBT_PUBLIC(int) MSG_process_self_PPID();
 323 XBT_PUBLIC(msg_process_t) MSG_process_self();
 324 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar();
 325 XBT_PUBLIC(int) MSG_process_get_number();
 326
 327 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
 328
 329 /*property handlers*/
 330 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
 331 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
 332                                                         process,
 333                                                         const char *name);
 334
 335 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
 336 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
 337 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
 338 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
 339 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 340
 341 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process);
 342 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
 343 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
 344 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
 345
 346 /************************** Task handling ************************************/
 347 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
 348                                      double flops_amount,
 349                                      double bytes_amount, void *data);
 350 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
 351                                               int host_nb,
 352                                               const msg_host_t * host_list,
 353                                               double *flops_amount,
 354                                               double *bytes_amount,
 355                                               void *data);
 356 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
 357 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
 358 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
 359     msg_task_t task, msg_process_t src, msg_process_t dst));
 360 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
 361 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
 362 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
 363 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
 364 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
 365 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
 366
 367 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
 368 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
 369 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
 370 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
 371 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
 372
 373 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
 374 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 375
 376 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
 377                                                double flops_amount);
 378 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
 379 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
 380                                         double bytes_amount);
 381
 382 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
 383 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 384 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
 385
 386
 387 XBT_PUBLIC(msg_error_t)
 388     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
 389                      msg_host_t host);
 390
 391 XBT_PUBLIC(msg_error_t)
 392     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
 393                               double timeout);
 394
 395 XBT_PUBLIC(msg_error_t)
 396     MSG_task_receive(msg_task_t * task, const char *alias);
 397 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 398
 399
 400
 401 XBT_PUBLIC(msg_error_t)
 402     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
 403                      msg_host_t host, double rate);
 404
 405 XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,  double timeout, double rate);
 406 XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
 407 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
 408
 409 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
 410 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
 411 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task, const char *alias,
 412     int (*match_fun)(void*,void*, smx_activity_t), void *match_data);
 413
 414 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
 415 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
 416 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
 417 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
 418 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
 419 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 420 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 421 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 422 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout);
 423 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 424 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
 425 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
 426
 427 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 428 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout);
 429 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate);
 430 XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias);
 431 XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
 432 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 433 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 434 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 435
 436 /************************** Mailbox handling ************************************/
 437
 438 /* @brief MSG_mailbox_set_async - set a mailbox as eager
 439  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
 440  * is issued, without waiting for the corresponding receive.
 441  * This call should be done before issuing any receive, and on the receiver's side only
 442  * @param alias    The alias of the mailbox to modify.
 443  */
 444 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
 445
 446 /************************** Action handling **********************************/
 447 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 448 XBT_PUBLIC(void) MSG_action_init();
 449 XBT_PUBLIC(void) MSG_action_exit();
 450
 451 /** @brief Opaque type representing a semaphore
 452  *  @ingroup msg_synchro
 453  *  @hideinitializer
 454  */
 455 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
 456 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
 457 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
 458 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 459 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
 460 XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
 461 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
 462 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
 463
 464 /** @brief Opaque type representing a barrier identifier
 465  *  @ingroup msg_synchro
 466  *  @hideinitializer
 467  */
 468
 469 #define MSG_BARRIER_SERIAL_PROCESS -1
 470 typedef struct s_msg_bar* msg_bar_t;
 471 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
 472 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
 473 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
 474
 475 /** @brief Opaque type describing a Virtual Machine.
 476  *  @ingroup msg_VMs
 477  *
 478  * All this is highly experimental and the interface will probably change in the future.
 479  * Please don't depend on this yet (although testing is welcomed if you feel so).
 480  * Usual lack of guaranty of any kind applies here, and is even increased.
 481  *
 482  */
 483
 484 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
 485 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
 486 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
 487 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
 488
 489 #define MSG_vm_get_name(vm) MSG_host_get_name(vm)
 490
 491 XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params);
 492 XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params);
 493
 494 // TODO add VDI later
 495 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
 496 XBT_PUBLIC(msg_vm_t)
 497 MSG_vm_create(msg_host_t ind_pm, const char* name, int ramsize, int mig_netspeed, int dp_intensity);
 498
 499 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 500
 501 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
 502
 503 /* Shutdown the guest operating system. */
 504 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
 505
 506 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
 507
 508 /* Suspend the execution of the VM, but keep its state on memory. */
 509 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
 510 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
 511
 512 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
 513 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
 514
 515
 516 #include "simgrid/instr.h"
 517
 518 /* ****************************************************************************************** */
 519 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 520 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 521
 522
 523 /* Functions renamed in 3.14 */
 524 #define MSG_mailbox_get_head(m) MSG_mailbox_front(m)
 525
 526
 527 SG_END_DECL()
 528
 529 #ifdef __cplusplus
 530 XBT_PUBLIC(msg_process_t)
 531 MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
 532                                 xbt_dict_t properties);
 533 #endif
 534
 535 #endif