include/simgrid/msg.h

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