include/simgrid/msg.h

   1 /* Copyright (c) 2004-2018. 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/engine.h>
  11 #include <simgrid/forward.h>
  12 #include <simgrid/host.h>
  13 #include <simgrid/instr.h>
  14 #include <simgrid/mailbox.h>
  15 #include <simgrid/plugins/live_migration.h>
  16 #include <simgrid/storage.h>
  17 #include <simgrid/vm.h>
  18 #include <simgrid/zone.h>
  19 #include <xbt.h>
  20
  21 #ifndef MIN
  22 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  23 #endif
  24 #ifndef MAX
  25 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  26 #endif
  27
  28 #ifdef __cplusplus
  29 #include <map>
  30 #include <simgrid/simix.h>
  31 namespace simgrid {
  32 namespace msg {
  33 class Comm;
  34 }
  35 }
  36 typedef simgrid::msg::Comm sg_msg_Comm;
  37 #else
  38 typedef struct msg_Comm sg_msg_Comm;
  39 #endif
  40
  41 SG_BEGIN_DECL()
  42
  43 /* *************************** Network Zones ******************************** */
  44 #define msg_as_t msg_netzone_t /* portability macro */
  45 typedef sg_netzone_t msg_netzone_t;
  46
  47 XBT_PUBLIC msg_netzone_t MSG_zone_get_root();
  48 XBT_PUBLIC const char* MSG_zone_get_name(msg_netzone_t zone);
  49 XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name);
  50 XBT_PUBLIC void MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
  51 XBT_PUBLIC const char* MSG_zone_get_property_value(msg_netzone_t zone, const char* name);
  52 XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, char* value);
  53 XBT_PUBLIC void MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
  54
  55 /* ******************************** Hosts ************************************ */
  56 typedef sg_host_t msg_host_t;
  57
  58 XBT_PUBLIC size_t MSG_get_host_number();
  59 XBT_PUBLIC sg_host_t MSG_get_host_by_name(const char* name);
  60 XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name);
  61
  62 XBT_PUBLIC xbt_dynar_t MSG_hosts_as_dynar();
  63
  64 XBT_PUBLIC const char* MSG_host_get_name(sg_host_t host);
  65 XBT_PUBLIC void* MSG_host_get_data(sg_host_t host);
  66 XBT_PUBLIC void MSG_host_set_data(sg_host_t host, void* data);
  67 XBT_PUBLIC xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host);
  68 XBT_PUBLIC xbt_dynar_t MSG_host_get_attached_storage_lists(sg_host_t host);
  69 XBT_PUBLIC double MSG_host_get_speed(sg_host_t host);
  70 XBT_PUBLIC double MSG_host_get_power_peak_at(sg_host_t host, int pstate_index);
  71 XBT_PUBLIC int MSG_host_get_core_number(sg_host_t host);
  72 XBT_PUBLIC int MSG_host_get_nb_pstates(sg_host_t host);
  73 XBT_PUBLIC int MSG_host_get_pstate(sg_host_t host);
  74 XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate);
  75 XBT_PUBLIC void MSG_host_on(sg_host_t h);
  76 XBT_PUBLIC void MSG_host_off(sg_host_t h);
  77 XBT_PUBLIC int MSG_host_is_on(sg_host_t h);
  78 XBT_PUBLIC int MSG_host_is_off(sg_host_t h);
  79 XBT_PUBLIC xbt_dict_t MSG_host_get_properties(sg_host_t host);
  80 XBT_PUBLIC const char* MSG_host_get_property_value(sg_host_t host, const char* name);
  81 XBT_PUBLIC void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value);
  82 XBT_PUBLIC void MSG_host_get_process_list(sg_host_t host, xbt_dynar_t whereto);
  83
  84 XBT_PUBLIC sg_host_t MSG_host_self();
  85
  86 /* ******************************** VMs ************************************* */
  87 typedef sg_vm_t msg_vm_t;
  88
  89 XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: "
  90                            "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC sg_vm_t
  91     MSG_vm_create(sg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
  92
  93 XBT_PUBLIC msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name);
  94 XBT_PUBLIC msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
  95
  96 XBT_PUBLIC int MSG_vm_is_created(msg_vm_t vm);
  97 XBT_PUBLIC int MSG_vm_is_running(msg_vm_t vm);
  98 XBT_PUBLIC int MSG_vm_is_suspended(msg_vm_t vm);
  99
 100 XBT_PUBLIC const char* MSG_vm_get_name(msg_vm_t vm);
 101 XBT_PUBLIC void MSG_vm_set_ramsize(msg_vm_t vm, size_t size);
 102 XBT_PUBLIC size_t MSG_vm_get_ramsize(msg_vm_t vm);
 103 XBT_PUBLIC msg_host_t MSG_vm_get_pm(msg_vm_t vm);
 104 XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound);
 105
 106 XBT_PUBLIC void MSG_vm_start(msg_vm_t vm);
 107 XBT_PUBLIC void MSG_vm_suspend(msg_vm_t vm);
 108 XBT_PUBLIC void MSG_vm_resume(msg_vm_t vm);
 109 XBT_PUBLIC void MSG_vm_shutdown(msg_vm_t vm);
 110 XBT_PUBLIC void MSG_vm_destroy(msg_vm_t vm);
 111
 112 /* ******************************** Storage ********************************* */
 113 typedef sg_storage_t msg_storage_t;
 114
 115 XBT_PUBLIC const char* MSG_storage_get_name(msg_storage_t storage);
 116 XBT_PUBLIC msg_storage_t MSG_storage_get_by_name(const char* name);
 117 XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(msg_storage_t storage);
 118 XBT_PUBLIC void MSG_storage_set_property_value(msg_storage_t storage, const char* name, const char* value);
 119 XBT_PUBLIC const char* MSG_storage_get_property_value(msg_storage_t storage, const char* name);
 120 XBT_PUBLIC xbt_dynar_t MSG_storages_as_dynar();
 121 XBT_PUBLIC void MSG_storage_set_data(msg_storage_t storage, void* data);
 122 XBT_PUBLIC void* MSG_storage_get_data(msg_storage_t storage);
 123 XBT_PUBLIC const char* MSG_storage_get_host(msg_storage_t storage);
 124 XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size);
 125 XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size);
 126
 127 /* ******************************** Actor/process *************************** */
 128 typedef sg_actor_t msg_process_t;
 129
 130 XBT_PUBLIC int MSG_process_get_PID(msg_process_t process);
 131 XBT_PUBLIC int MSG_process_get_PPID(msg_process_t process);
 132 XBT_PUBLIC sg_actor_t MSG_process_from_PID(int pid);
 133 XBT_PUBLIC const char* MSG_process_get_name(msg_process_t process);
 134 XBT_PUBLIC sg_host_t MSG_process_get_host(msg_process_t process);
 135
 136 /*property handlers*/
 137 XBT_PUBLIC xbt_dict_t MSG_process_get_properties(msg_process_t process);
 138 XBT_PUBLIC const char* MSG_process_get_property_value(msg_process_t process, const char* name);
 139
 140 XBT_PUBLIC void MSG_process_suspend(msg_process_t process);
 141 XBT_PUBLIC void MSG_process_resume(msg_process_t process);
 142 XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process);
 143 XBT_PUBLIC void MSG_process_restart(msg_process_t process);
 144 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 145 XBT_PUBLIC void MSG_process_daemonize(msg_process_t process);
 146 XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host);
 147 XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout);
 148 XBT_PUBLIC void MSG_process_kill(msg_process_t process);
 149 XBT_PUBLIC void MSG_process_killall();
 150 XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time);
 151 XBT_PUBLIC void MSG_process_yield();
 152
 153
 154 /**
 155  * \brief @brief Communication action.
 156  * \ingroup msg_task_usage
 157  *
 158  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 159  */
 160 typedef sg_msg_Comm* msg_comm_t;
 161
 162 /* ******************************** Task ************************************ */
 163
 164 typedef struct s_simdata_task_t* simdata_task_t;
 165
 166 typedef struct msg_task {
 167   char* name;             /**< @brief task name if any */
 168   simdata_task_t simdata; /**< @brief simulator data */
 169   void* data;             /**< @brief user data */
 170   long long int counter;  /* task unique identifier for instrumentation */
 171   char* category;         /* task category for instrumentation */
 172 } s_msg_task_t;
 173
 174 /** @brief Task datatype.
 175     @ingroup m_task_management
 176
 177     A <em>task</em> may then be defined by a <em>computing
 178     amount</em>, a <em>message size</em> and some <em>private
 179     data</em>.
 180  */
 181
 182 typedef struct msg_task* msg_task_t;
 183
 184 /** \brief Default value for an uninitialized #msg_task_t.
 185     \ingroup m_task_management
 186 */
 187 #define MSG_TASK_UNINITIALIZED NULL
 188
 189 /** @brief Return code of most MSG functions
 190     @ingroup msg_simulation
 191     @{ */
 192 /* Keep these code as binary values: java bindings manipulate | of these values */
 193 typedef enum {
 194   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
 195   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
 196   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
 197       transfer. Either the network is down or the remote host has been
 198       shutdown. */
 199   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
 200       running has just been rebooted. Free your datastructures and
 201       return now !*/
 202   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 203 } msg_error_t;
 204 /** @} */
 205
 206 /************************** Global ******************************************/
 207 XBT_PUBLIC void MSG_config(const char* key, const char* value);
 208 /** \ingroup msg_simulation
 209  *  \brief Initialize the MSG internal data.
 210  *  \hideinitializer
 211  *
 212  *  It also check that the link-time and compile-time versions of SimGrid do
 213  *  match, so you should use this version instead of the #MSG_init_nocheck
 214  *  function that does the same initializations, but without this check.
 215  *
 216  *  We allow to link against compiled versions that differ in the patch level.
 217  */
 218 #define MSG_init(argc,argv)  do {                                                          \
 219   sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
 220     MSG_init_nocheck(argc,argv);                                                        \
 221   } while (0)
 222
 223 XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv);
 224 XBT_PUBLIC msg_error_t MSG_main();
 225 XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code);
 226 XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code);
 227 XBT_PUBLIC void MSG_create_environment(const char* file);
 228 XBT_PUBLIC void MSG_launch_application(const char* file);
 229 /*Bypass the parser */
 230 XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments);
 231
 232 XBT_PUBLIC double MSG_get_clock();
 233 XBT_PUBLIC unsigned long int MSG_get_sent_msg();
 234
 235 /************************** Process handling *********************************/
 236 XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host);
 237 XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data,
 238                                                            msg_host_t host, int argc, char** argv);
 239 XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data,
 240                                                              msg_host_t host, int argc, char** argv,
 241                                                              xbt_dict_t properties);
 242
 243 XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
 244 XBT_PUBLIC void MSG_process_detach();
 245
 246 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 247 XBT_PUBLIC int MSG_process_self_PID();
 248 XBT_PUBLIC int MSG_process_self_PPID();
 249 XBT_PUBLIC const char* MSG_process_self_name();
 250 XBT_PUBLIC msg_process_t MSG_process_self();
 251 XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar();
 252 XBT_PUBLIC int MSG_process_get_number();
 253
 254 XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
 255 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
 256
 257 XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
 258
 259 XBT_PUBLIC void MSG_process_ref(msg_process_t process);
 260 XBT_PUBLIC void MSG_process_unref(msg_process_t process);
 261
 262 /************************** Task handling ************************************/
 263 XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
 264 XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list,
 265                                                double* flops_amount, double* bytes_amount, void* data);
 266 XBT_PUBLIC void* MSG_task_get_data(msg_task_t task);
 267 XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data);
 268 XBT_PUBLIC void MSG_task_set_copy_callback(void (*callback)(msg_task_t task, msg_process_t src, msg_process_t dst));
 269 XBT_PUBLIC msg_process_t MSG_task_get_sender(msg_task_t task);
 270 XBT_PUBLIC msg_host_t MSG_task_get_source(msg_task_t task);
 271 XBT_PUBLIC const char* MSG_task_get_name(msg_task_t task);
 272 XBT_PUBLIC void MSG_task_set_name(msg_task_t task, const char* name);
 273 XBT_PUBLIC msg_error_t MSG_task_cancel(msg_task_t task);
 274 XBT_PUBLIC msg_error_t MSG_task_destroy(msg_task_t task);
 275
 276 XBT_PUBLIC msg_error_t MSG_task_execute(msg_task_t task);
 277 XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task);
 278 XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
 279 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
 280 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
 281
 282 XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
 283
 284 XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
 285 XBT_PUBLIC double MSG_task_get_flops_amount(msg_task_t task);
 286 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task);
 287 XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
 288
 289 XBT_PUBLIC double MSG_task_get_remaining_communication(msg_task_t task);
 290 XBT_PUBLIC double MSG_task_get_bytes_amount(msg_task_t task);
 291
 292 XBT_PUBLIC msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
 293
 294 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
 295
 296 XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias);
 297 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 298
 299 XBT_PUBLIC msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout,
 300                                                     msg_host_t host, double rate);
 301
 302 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout,
 303                                                              double rate);
 304 XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate);
 305 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
 306
 307 XBT_PUBLIC msg_comm_t MSG_task_isend(msg_task_t task, const char* alias);
 308 XBT_PUBLIC msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate);
 309
 310 XBT_PUBLIC void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup);
 311 XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate);
 312 XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias);
 313 XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate);
 314 XBT_PUBLIC int MSG_comm_test(msg_comm_t comm);
 315 XBT_PUBLIC int MSG_comm_testany(xbt_dynar_t comms);
 316 XBT_PUBLIC void MSG_comm_destroy(msg_comm_t comm);
 317 XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout);
 318 XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout);
 319 XBT_PUBLIC int MSG_comm_waitany(xbt_dynar_t comms);
 320 XBT_PUBLIC msg_task_t MSG_comm_get_task(msg_comm_t comm);
 321 XBT_PUBLIC msg_error_t MSG_comm_get_status(msg_comm_t comm);
 322
 323 XBT_PUBLIC int MSG_task_listen(const char* alias);
 324 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout);
 325 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout,
 326                                                           double maxrate);
 327 XBT_PUBLIC msg_error_t MSG_task_send(msg_task_t task, const char* alias);
 328 XBT_PUBLIC msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double rate);
 329 XBT_PUBLIC int MSG_task_listen_from(const char* alias);
 330 XBT_PUBLIC void MSG_task_set_category(msg_task_t task, const char* category);
 331 XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task);
 332
 333 /************************** Mailbox handling ************************************/
 334
 335 /* @brief MSG_mailbox_set_async - set a mailbox as eager
 336  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
 337  * is issued, without waiting for the corresponding receive.
 338  * This call should be done before issuing any receive, and on the receiver's side only
 339  * @param alias    The alias of the mailbox to modify.
 340  */
 341 XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
 342
 343 /** @brief Opaque type representing a semaphore
 344  *  @ingroup msg_synchro
 345  *  @hideinitializer
 346  */
 347 typedef struct s_smx_sem_t* msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be
 348                                        // declared here
 349 XBT_PUBLIC msg_sem_t MSG_sem_init(int initial_value);
 350 XBT_PUBLIC void MSG_sem_acquire(msg_sem_t sem);
 351 XBT_PUBLIC msg_error_t MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 352 XBT_PUBLIC void MSG_sem_release(msg_sem_t sem);
 353 XBT_PUBLIC int MSG_sem_get_capacity(msg_sem_t sem);
 354 XBT_PUBLIC void MSG_sem_destroy(msg_sem_t sem);
 355 XBT_PUBLIC int MSG_sem_would_block(msg_sem_t sem);
 356
 357 /** @brief Opaque type representing a barrier identifier
 358  *  @ingroup msg_synchro
 359  *  @hideinitializer
 360  */
 361
 362 #define MSG_BARRIER_SERIAL_PROCESS -1
 363 typedef struct s_msg_bar_t* msg_bar_t;
 364 XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count);
 365 XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar);
 366 XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
 367
 368 /* ****************************************************************************************** */
 369 /* DO NOT USE this nasty pimple (unless if you're writing a binding) */
 370 XBT_PUBLIC smx_context_t
 371 XBT_ATTRIB_DEPRECATED_v323("MSG_process_get_smx_ctx is deprecated. Please contact us if you need it.")
 372 MSG_process_get_smx_ctx(msg_process_t process);
 373
 374 SG_END_DECL()
 375
 376 #ifdef __cplusplus
 377 XBT_PUBLIC msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data,
 378                                                          msg_host_t host,
 379                                                          std::unordered_map<std::string, std::string>* properties);
 380 #endif
 381
 382 #endif