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