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