include/simgrid/msg.h

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