include/simgrid/msg.h

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