include/simgrid/msg.h

   1 /* Copyright (c) 2004-2020. 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 SIMGRID_MSG_H
   7 #define SIMGRID_MSG_H
   8
   9 #include <simgrid/actor.h>
  10 #include <simgrid/barrier.h>
  11 #include <simgrid/engine.h>
  12 #include <simgrid/forward.h>
  13 #include <simgrid/host.h>
  14 #include <simgrid/instr.h>
  15 #include <simgrid/mailbox.h>
  16 #include <simgrid/mutex.h>
  17 #include <simgrid/plugins/live_migration.h>
  18 #include <simgrid/semaphore.h>
  19 #include <simgrid/storage.h>
  20 #include <simgrid/version.h>
  21 #include <simgrid/vm.h>
  22 #include <simgrid/zone.h>
  23 #include <xbt.h>
  24
  25 #ifndef MIN
  26 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  27 #endif
  28 #ifndef MAX
  29 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  30 #endif
  31
  32 #ifdef __cplusplus
  33 #include <map>
  34 #include <simgrid/simix.h>
  35 namespace simgrid {
  36 namespace msg {
  37 class Comm;
  38 class Task;
  39 }
  40 }
  41 typedef simgrid::msg::Comm sg_msg_Comm;
  42 typedef simgrid::msg::Task sg_msg_Task;
  43 #else
  44 typedef struct msg_Comm sg_msg_Comm;
  45 typedef struct msg_Task sg_msg_Task;
  46 #endif
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 /** @brief Return code of most MSG functions */
  53 /* Keep these code as binary values: java bindings manipulate | of these values */
  54 typedef enum {
  55   MSG_OK               = 0, /**< @brief Everything is right. Keep on going this way ! */
  56   MSG_TIMEOUT          = 1, /**< @brief nothing good happened before the timer you provided elapsed */
  57   MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
  58     transfer. Either the network is down or the remote host has been
  59     shutdown. */
  60   MSG_HOST_FAILURE = 4,     /**< @brief System shutdown. The host on which you are
  61     running has just been rebooted. Free your datastructures and
  62     return now !*/
  63   MSG_TASK_CANCELED = 8     /**< @brief Canceled task. This task has been canceled by somebody!*/
  64 } msg_error_t;
  65
  66 /* *************************** Network Zones ******************************** */
  67 typedef sg_netzone_t msg_netzone_t;
  68
  69 XBT_PUBLIC msg_netzone_t MSG_zone_get_root();
  70 XBT_PUBLIC const char* MSG_zone_get_name(const_sg_netzone_t zone);
  71 XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name);
  72 XBT_PUBLIC void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto);
  73 XBT_PUBLIC const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name);
  74 XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, const char* value);
  75 XBT_PUBLIC void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto);
  76
  77 /* ******************************** Hosts ************************************ */
  78 /** @brief Host datatype.
  79  *
  80  * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it is represented as a
  81  * <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
  82  * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
  83  */
  84 typedef sg_host_t msg_host_t;
  85
  86 /** @brief Finds a msg_host_t using its name. */
  87 XBT_PUBLIC sg_host_t MSG_get_host_by_name(const char* name);
  88 /** @brief Finds a msg_host_t using its name. */
  89 XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name);
  90
  91 /** @brief Returns the amount of host found in the platform */
  92 XBT_PUBLIC size_t MSG_get_host_number();
  93 /** @brief Returns a dynar with all existing hosts
  94  *
  95  * The host order in the returned array is generally different from the host creation/declaration order in the XML
  96  * platform (we use a hash table internally).
  97  */
  98 XBT_PUBLIC xbt_dynar_t MSG_hosts_as_dynar();
  99
 100 /** @brief Returns the name of this host */
 101 XBT_PUBLIC const char* MSG_host_get_name(const_sg_host_t host);
 102 /** @brief Returns the user data of this host */
 103 XBT_PUBLIC void* MSG_host_get_data(const_sg_host_t host);
 104 /** @brief Sets the user data of this host */
 105 XBT_PUBLIC void MSG_host_set_data(sg_host_t host, void* data);
 106 XBT_PUBLIC xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host);
 107 XBT_PUBLIC xbt_dynar_t MSG_host_get_attached_storage_lists(const_sg_host_t host);
 108 XBT_PUBLIC double MSG_host_get_speed(const_sg_host_t host);
 109 XBT_PUBLIC double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index);
 110 XBT_PUBLIC int MSG_host_get_core_number(const_sg_host_t host);
 111 XBT_PUBLIC int MSG_host_get_nb_pstates(const_sg_host_t host);
 112 XBT_PUBLIC int MSG_host_get_pstate(const_sg_host_t host);
 113 XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate);
 114 /** @brief Start the host if it is off
 115  *
 116  * @beginrst
 117  * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy`
 118  * for more info on DVFS.
 119  * @endrst
 120  */
 121 XBT_PUBLIC void MSG_host_on(sg_host_t h);
 122 /** @brief Stop the host if it is on
 123  *
 124  * @beginrst
 125  * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy`
 126  * for more info on DVFS.
 127  * @endrst
 128  */
 129 XBT_PUBLIC void MSG_host_off(sg_host_t h);
 130 XBT_PUBLIC int MSG_host_is_on(const_sg_host_t h);
 131 XBT_PUBLIC xbt_dict_t MSG_host_get_properties(const_sg_host_t host);
 132 XBT_PUBLIC const char* MSG_host_get_property_value(const_sg_host_t host, const char* name);
 133 XBT_PUBLIC void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value);
 134 XBT_PUBLIC void MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto);
 135
 136 /** @brief Return the location on which the current process is executed */
 137 XBT_PUBLIC sg_host_t MSG_host_self();
 138 XBT_PUBLIC double MSG_host_get_load(const_sg_host_t host);
 139
 140 /* ******************************** VMs ************************************* */
 141 typedef sg_vm_t msg_vm_t;
 142
 143 XBT_PUBLIC msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name);
 144 XBT_PUBLIC msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
 145
 146 XBT_PUBLIC int MSG_vm_is_created(msg_vm_t vm);
 147 XBT_PUBLIC int MSG_vm_is_running(msg_vm_t vm);
 148 XBT_PUBLIC int MSG_vm_is_suspended(msg_vm_t vm);
 149
 150 XBT_PUBLIC const char* MSG_vm_get_name(const_sg_vm_t vm);
 151 XBT_PUBLIC void MSG_vm_set_ramsize(msg_vm_t vm, size_t size);
 152 XBT_PUBLIC size_t MSG_vm_get_ramsize(const_sg_vm_t vm);
 153 XBT_PUBLIC msg_host_t MSG_vm_get_pm(const_sg_vm_t vm);
 154 XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound);
 155
 156 XBT_PUBLIC void MSG_vm_start(msg_vm_t vm);
 157 XBT_PUBLIC void MSG_vm_suspend(msg_vm_t vm);
 158 XBT_PUBLIC void MSG_vm_resume(msg_vm_t vm);
 159 XBT_PUBLIC void MSG_vm_shutdown(msg_vm_t vm);
 160 XBT_PUBLIC void MSG_vm_destroy(msg_vm_t vm);
 161
 162 /* ******************************** Storage ********************************* */
 163 typedef sg_storage_t msg_storage_t;
 164
 165 XBT_PUBLIC const char* MSG_storage_get_name(const_sg_storage_t storage);
 166 XBT_PUBLIC msg_storage_t MSG_storage_get_by_name(const char* name);
 167 XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(const_sg_storage_t storage);
 168 XBT_PUBLIC void MSG_storage_set_property_value(msg_storage_t storage, const char* name, const char* value);
 169 XBT_PUBLIC const char* MSG_storage_get_property_value(const_sg_storage_t storage, const char* name);
 170 XBT_PUBLIC xbt_dynar_t MSG_storages_as_dynar();
 171 XBT_PUBLIC void MSG_storage_set_data(msg_storage_t storage, void* data);
 172 XBT_PUBLIC void* MSG_storage_get_data(const_sg_storage_t storage);
 173 XBT_PUBLIC const char* MSG_storage_get_host(const_sg_storage_t storage);
 174 XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size);
 175 XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size);
 176
 177 /* ******************************** Actor/process *************************** */
 178 /** Processes are independent agents that can do stuff on their own.
 179  *  They are in charge of executing your code interacting with the simulated world.
 180  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
 181  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
 182  *  that are similar to envelops containing data.
 183  *
 184  *  @hideinitializer
 185  */
 186 typedef sg_actor_t msg_process_t;
 187
 188 XBT_PUBLIC int MSG_process_get_PID(const_sg_actor_t process);
 189 XBT_PUBLIC int MSG_process_get_PPID(const_sg_actor_t process);
 190 /** @brief Return a process from its PID (or NULL if not found).
 191  *
 192  * Note that the PID are unique in the whole simulation, not only on a given host.
 193  */
 194 XBT_PUBLIC sg_actor_t MSG_process_from_PID(int pid);
 195 XBT_PUBLIC const char* MSG_process_get_name(const_sg_actor_t process);
 196 XBT_PUBLIC sg_host_t MSG_process_get_host(const_sg_actor_t process);
 197
 198 /*property handlers*/
 199 XBT_PUBLIC xbt_dict_t MSG_process_get_properties(const_sg_actor_t process);
 200 XBT_PUBLIC const char* MSG_process_get_property_value(const_sg_actor_t process, const char* name);
 201
 202 XBT_PUBLIC void MSG_process_suspend(msg_process_t process);
 203 XBT_PUBLIC void MSG_process_resume(msg_process_t process);
 204 XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process);
 205 XBT_PUBLIC void MSG_process_restart(msg_process_t process);
 206 /** @brief Sets the "auto-restart" flag of the process.
 207  *
 208  * If the flag is set, the process will be automatically restarted when its host comes back up.
 209  */
 210 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 211 /** @brief Indicates that this process should not prevent the simulation from ending
 212  *
 213  * SimGrid simulations run until all non-daemon processes are stopped.
 214  */
 215 XBT_PUBLIC void MSG_process_daemonize(msg_process_t process);
 216 /** @brief Immediately changes the host on which this process runs */
 217 XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host);
 218 /** @brief Wait for the completion of a process.
 219  *
 220  * @param process the process to wait for
 221  * @param timeout wait until the process is over, or the timeout occurs
 222  */
 223 XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout);
 224 /** @brief Kills a process */
 225 XBT_PUBLIC void MSG_process_kill(msg_process_t process);
 226 /** @brief Kill all running process */
 227 XBT_PUBLIC void MSG_process_killall();
 228 /** @brief Specifies the time at which the process should be automatically killed */
 229 XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time);
 230 /** @brief Yield the current actor; let the other actors execute first */
 231 XBT_PUBLIC void MSG_process_yield();
 232 /*** @brief Sleep for the specified number of seconds */
 233 XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
 234 XBT_PUBLIC msg_process_t MSG_process_self();
 235 XBT_PUBLIC aid_t MSG_process_self_PID();
 236 XBT_PUBLIC aid_t MSG_process_self_PPID();
 237 XBT_PUBLIC const char* MSG_process_self_name();
 238 XBT_PUBLIC void MSG_process_ref(const_sg_actor_t process);
 239 XBT_PUBLIC void MSG_process_unref(const_sg_actor_t process);
 240
 241 /** @brief Object representing an ongoing communication between processes.
 242  *
 243  * \rst
 244  * Such beast is usually obtained by using :cpp:func:`MSG_task_isend`, :cpp:func:`MSG_task_irecv` or friends.
 245  * \endrst
 246  */
 247 typedef sg_msg_Comm* msg_comm_t;
 248 typedef const sg_msg_Comm* const_msg_comm_t;
 249
 250 /** @brief Task datatype.
 251  *
 252  *  Since most scheduling algorithms rely on a concept of task  that can be either <em>computed</em> locally or
 253  *  <em>transferred</em> on another processor, it seems to be the right level of abstraction for our purposes.
 254  *  A <em>task</em> may then be defined by a <em>computing amount</em>, a <em>message size</em> and
 255  *  some <em>private data</em>.
 256  */
 257 typedef sg_msg_Task* msg_task_t;
 258 typedef const sg_msg_Task* const_msg_task_t;
 259
 260 /* ******************************** Task ************************************ */
 261
 262
 263 /** @brief Default value for an uninitialized #msg_task_t. */
 264 #define MSG_TASK_UNINITIALIZED NULL
 265
 266 /************************** Global ******************************************/
 267 /** @brief set a configuration variable
 268  *
 269  * @beginrst
 270  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section
 271  * :ref:`options`.
 272  * @endrst
 273  *
 274  * Example:
 275  * MSG_config("host/model","ptask_L07");
 276  */
 277 XBT_PUBLIC void MSG_config(const char* key, const char* value);
 278 /** @brief Initialize the MSG internal data.
 279  *  @hideinitializer
 280  *
 281  *  It also checks that the link-time and compile-time versions of SimGrid do
 282  *  match, so you should use this version instead of the #MSG_init_nocheck
 283  *  function that does the same initializations, but without this check.
 284  *
 285  *  We allow linking against compiled versions that differ in the patch level.
 286  */
 287 #define MSG_init(argc, argv)                                                                                           \
 288   do {                                                                                                                 \
 289     sg_version_check(SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR, SIMGRID_VERSION_PATCH);                             \
 290     MSG_init_nocheck((argc), (argv));                                                                                  \
 291   } while (0)
 292
 293 XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv);
 294 /** @brief Launch the MSG simulation */
 295 XBT_PUBLIC msg_error_t MSG_main();
 296 /** @brief Registers the main function of a process in a global table.
 297  *
 298  * This table is then used by #MSG_launch_application.
 299  * @param name the reference name of the function.
 300  * @param code the function (must have the same prototype than the main function of any C program: int ..(int argc, char
 301  * *argv[]))
 302  */
 303 XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code);
 304 /** @brief Registers a code function as being the default value.
 305  *
 306  * This function will get used by MSG_launch_application() when there is no registered function of the requested name
 307  * in.
 308  *
 309  * @param code the function (must have the same prototype than the main function of any C program: int ..(int argc, char
 310  * *argv[]))
 311  */
 312 XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code);
 313 /** @brief Creates a new platform, including hosts, links and the routing_table */
 314 XBT_PUBLIC void MSG_create_environment(const char* file);
 315 /** @brief Creates the application described in the provided file */
 316 XBT_PUBLIC void MSG_launch_application(const char* file);
 317
 318 #ifndef DOXYGEN
 319 /** @brief register functions bypassing the parser */
 320 XBT_ATTRIB_DEPRECATED_v329("This function will be removed. Speak up if you need it.") XBT_PUBLIC
 321     void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments);
 322 #endif
 323
 324 /** @brief A clock (in second). */
 325 XBT_PUBLIC double MSG_get_clock();
 326 /** @brief Returns the amount of messages sent since the simulation start */
 327 XBT_PUBLIC unsigned long int MSG_get_sent_msg();
 328
 329 /************************** Process handling *********************************/
 330 XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host);
 331 XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data,
 332                                                            msg_host_t host, int argc, char** argv);
 333 XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data,
 334                                                              msg_host_t host, int argc, char** argv,
 335                                                              xbt_dict_t properties);
 336
 337 XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
 338 XBT_PUBLIC void MSG_process_detach();
 339
 340 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 341 XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar();
 342 XBT_PUBLIC int MSG_process_get_number();
 343
 344 XBT_PUBLIC void* MSG_process_get_data(const_sg_actor_t process);
 345 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
 346
 347 XBT_PUBLIC void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data);
 348
 349 /************************** Task handling ************************************/
 350 XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
 351 XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list,
 352                                                double* flops_amount, double* bytes_amount, void* data);
 353 XBT_PUBLIC void* MSG_task_get_data(const_msg_task_t task);
 354 XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data);
 355 XBT_PUBLIC msg_process_t MSG_task_get_sender(const_msg_task_t task);
 356 XBT_PUBLIC msg_host_t MSG_task_get_source(const_msg_task_t task);
 357 XBT_PUBLIC const char* MSG_task_get_name(const_msg_task_t task);
 358 XBT_PUBLIC void MSG_task_set_name(msg_task_t task, const char* name);
 359 XBT_PUBLIC msg_error_t MSG_task_cancel(msg_task_t task);
 360 XBT_PUBLIC msg_error_t MSG_task_destroy(msg_task_t task);
 361
 362 XBT_PUBLIC msg_error_t MSG_task_execute(msg_task_t task);
 363 XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task);
 364 XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
 365 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
 366 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
 367
 368 XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
 369 XBT_PUBLIC double MSG_task_get_flops_amount(const_msg_task_t task);
 370 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(const_msg_task_t task);
 371 XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
 372
 373 XBT_PUBLIC double MSG_task_get_remaining_communication(const_msg_task_t task);
 374 XBT_PUBLIC double MSG_task_get_bytes_amount(const_msg_task_t task);
 375
 376 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
 377
 378 XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias);
 379 #define MSG_task_recv(t, a) MSG_task_receive((t), (a))
 380
 381 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout,
 382                                                              double rate);
 383 XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate);
 384 #define MSG_task_recv_bounded(t, a, r) MSG_task_receive_bounded((t), (a), (r))
 385
 386 XBT_PUBLIC msg_comm_t MSG_task_isend(msg_task_t task, const char* alias);
 387 XBT_PUBLIC msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate);
 388
 389 XBT_PUBLIC void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup);
 390 XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate);
 391 XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias);
 392 XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate);
 393 XBT_PUBLIC int MSG_comm_test(msg_comm_t comm);
 394 XBT_PUBLIC int MSG_comm_testany(const_xbt_dynar_t comms);
 395 XBT_PUBLIC void MSG_comm_destroy(const_msg_comm_t comm);
 396 XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout);
 397 XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout);
 398 XBT_PUBLIC int MSG_comm_waitany(const_xbt_dynar_t comms);
 399 XBT_PUBLIC msg_task_t MSG_comm_get_task(const_msg_comm_t comm);
 400 XBT_PUBLIC msg_error_t MSG_comm_get_status(const_msg_comm_t comm);
 401
 402 /** @brief Check if there is a communication going on in a mailbox.
 403  *
 404  * @param alias the name of the mailbox to be considered
 405  *
 406  * @return Returns 1 if there is a communication, 0 otherwise
 407  */
 408 XBT_PUBLIC int MSG_task_listen(const char* alias);
 409 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout);
 410 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout,
 411                                                           double maxrate);
 412 XBT_PUBLIC msg_error_t MSG_task_send(msg_task_t task, const char* alias);
 413 XBT_PUBLIC msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double rate);
 414 XBT_PUBLIC int MSG_task_listen_from(const char* alias);
 415 XBT_PUBLIC void MSG_task_set_category(msg_task_t task, const char* category);
 416 XBT_PUBLIC const char* MSG_task_get_category(const_msg_task_t task);
 417
 418 /************************** Mailbox handling ************************************/
 419
 420 /* @brief set a mailbox in eager mode.
 421  * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
 422  * The receive call will still be necessary to use the received data.
 423  * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
 424  *
 425  * This call should be done before issuing any receive, and on the receiver's side only
 426  */
 427 XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
 428
 429 /** @brief Opaque type representing a semaphore */
 430 typedef sg_sem_t msg_sem_t;
 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 int 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(const_sg_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 typedef sg_bar_t msg_bar_t;
 441 /** @brief Initializes a barrier, with count elements */
 442 XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count);
 443 /** @brief Destroys barrier */
 444 XBT_PUBLIC void MSG_barrier_destroy(const_sg_bar_t bar);
 445 /** @brief Performs a barrier already initialized */
 446 XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
 447
 448 /* ****************************************************************************************** */
 449 #ifdef __cplusplus
 450 }
 451 #endif
 452
 453 #endif