include/simgrid/msg.h

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MSG_H
   8 #define MSG_H
   9
  10 #include "xbt.h"
  11 #include "xbt/lib.h"
  12 #include "simgrid/forward.h"
  13 #include "simgrid/simix.h"
  14
  15 SG_BEGIN_DECL()
  16
  17 /* *************************** Network Zones ******************************** */
  18 #define msg_as_t msg_netzone_t /* portability macro */
  19 typedef s4u_NetZone* msg_netzone_t;
  20
  21 /* ******************************** Host ************************************ */
  22
  23 /** @brief Host datatype.
  24     @ingroup m_host_management
  25
  26     A <em>location</em> (or <em>host</em>) is any possible place where
  27     a process may run. Thus it is represented as a <em>physical
  28     resource with computing capabilities</em>, some <em>mailboxes</em>
  29     to enable running process to communicate with remote ones, and
  30     some <em>private data</em> that can be only accessed by local
  31     process.
  32  */
  33 typedef sg_host_t msg_host_t;
  34
  35
  36 XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
  37 /* ******************************** Task ************************************ */
  38
  39 typedef struct simdata_task *simdata_task_t;
  40
  41 typedef struct msg_task {
  42   char *name;                   /**< @brief task name if any */
  43   simdata_task_t simdata;       /**< @brief simulator data */
  44   void *data;                   /**< @brief user data */
  45   long long int counter;        /* task unique identifier for instrumentation */
  46   char *category;               /* task category for instrumentation */
  47 } s_msg_task_t;
  48
  49 /** @brief Task datatype.
  50     @ingroup m_task_management
  51
  52     A <em>task</em> may then be defined by a <em>computing
  53     amount</em>, a <em>message size</em> and some <em>private
  54     data</em>.
  55  */
  56 typedef struct msg_task *msg_task_t;
  57
  58 /* ******************************** VM ************************************* */
  59 typedef msg_host_t msg_vm_t;
  60
  61 /* ******************************** File ************************************ */
  62
  63 /** @brief Opaque object describing a File in MSG.
  64  *  @ingroup msg_file */
  65 typedef xbt_dictelm_t msg_file_t;
  66
  67 extern int MSG_FILE_LEVEL;
  68 typedef struct simdata_file *simdata_file_t;
  69
  70 struct msg_file_priv  {
  71   char *fullpath;
  72   sg_size_t size;
  73   char* mount_point;
  74   char* storageId;
  75   char* storage_type;
  76   char* content_type;
  77   int desc_id;
  78   void *data;
  79   simdata_file_t simdata;
  80 };
  81
  82 typedef struct msg_file_priv s_msg_file_priv_t;
  83 typedef struct msg_file_priv* msg_file_priv_t;
  84
  85 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
  86   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
  87 }
  88
  89 /* ******************************** Storage ************************************ */
  90 /* TODO: PV: to comment */
  91
  92 extern int MSG_STORAGE_LEVEL;
  93
  94 /** @brief Storage datatype.
  95  *  @ingroup msg_storage_management
  96  *
  97  *  You should consider this as an opaque object.
  98  */
  99 typedef xbt_dictelm_t msg_storage_t;
 100
 101 struct msg_storage_priv  {
 102   const char *hostname;
 103   void *data;
 104 };
 105 typedef struct msg_storage_priv  s_msg_storage_priv_t;
 106 typedef struct msg_storage_priv* msg_storage_priv_t;
 107
 108 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
 109   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
 110 }
 111
 112 /**
 113  * \brief @brief Communication action.
 114  * \ingroup msg_task_usage
 115  *
 116  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 117  */
 118 typedef struct msg_comm *msg_comm_t;
 119
 120 /** \brief Default value for an uninitialized #msg_task_t.
 121     \ingroup m_task_management
 122 */
 123 #define MSG_TASK_UNINITIALIZED NULL
 124
 125 /* ****************************** Process *********************************** */
 126
 127 /** @brief Process datatype.
 128     @ingroup m_process_management
 129
 130     A process may be defined as a <em>code</em>, with some
 131     <em>private data</em>, executing in a <em>location</em>.
 132
 133     You should not access directly to the fields of the pointed
 134     structure, but always use the provided API to interact with
 135     processes.
 136  */
 137 typedef s4u_Actor* msg_process_t;
 138
 139 /** @brief Return code of most MSG functions
 140     @ingroup msg_simulation
 141     @{ */
 142 /* Keep these code as binary values: java bindings manipulate | of these values */
 143 typedef enum {
 144   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
 145   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
 146   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
 147       transfer. Either the network is down or the remote host has been
 148       shutdown. */
 149   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
 150       running has just been rebooted. Free your datastructures and
 151       return now !*/
 152   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 153 } msg_error_t;
 154 /** @} */
 155
 156 /************************** Global ******************************************/
 157 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
 158 /** \ingroup msg_simulation
 159  *  \brief Initialize the MSG internal data.
 160  *  \hideinitializer
 161  *
 162  *  It also check that the link-time and compile-time versions of SimGrid do
 163  *  match, so you should use this version instead of the #MSG_init_nocheck
 164  *  function that does the same initializations, but without this check.
 165  *
 166  *  We allow to link against compiled versions that differ in the patch level.
 167  */
 168 #define MSG_init(argc,argv)  do {                                                          \
 169   sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
 170     MSG_init_nocheck(argc,argv);                                                        \
 171   } while (0)
 172
 173 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
 174 XBT_PUBLIC(msg_error_t) MSG_main();;
 175 XBT_PUBLIC(void) MSG_function_register(const char *name,
 176                                        xbt_main_func_t code);
 177 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
 178 XBT_PUBLIC(void) MSG_launch_application(const char *file);
 179 /*Bypass the parser */
 180 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
 181                                   const char *function_name,
 182                                   xbt_dynar_t arguments);
 183
 184 XBT_PUBLIC(double) MSG_get_clock();
 185 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg();
 186
 187 /************************** Environment ***********************************/
 188 XBT_PUBLIC(msg_netzone_t) MSG_environment_get_routing_root();
 189 XBT_PUBLIC(const char*) MSG_environment_as_get_name(msg_netzone_t as);
 190 XBT_PUBLIC(msg_netzone_t) MSG_environment_as_get_by_name(const char* name);
 191 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_netzone_t as);
 192 XBT_PUBLIC(const char*) MSG_environment_as_get_property_value(msg_netzone_t as, const char* name);
 193 XBT_PUBLIC(void) MSG_environment_as_set_property_value(msg_netzone_t netzone, const char* name, char* value);
 194 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_netzone_t as);
 195
 196 /************************** File handling ***********************************/
 197 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
 198 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
 199 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
 200 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
 201 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
 202 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
 203 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
 204 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
 205 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
 206 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
 207 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
 208 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
 209 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
 210 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
 211 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
 212 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
 213 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
 214 /************************** Storage handling ***********************************/
 215 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
 216 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
 217 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
 218 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
 219 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
 220 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
 221 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
 222 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
 223 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
 224 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
 225 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
 226 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
 227 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
 228 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
 229
 230 /************************** Host handling ***********************************/
 231 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
 232 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
 233 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
 234 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 235 /** \ingroup m_host_management
 236  *
 237  * \brief Return the name of the #msg_host_t. */
 238 #define MSG_host_get_name(host) sg_host_get_name(host)
 239 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
 240 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
 241 XBT_PUBLIC(msg_host_t) MSG_host_self();
 242 XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
 243 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 244 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
 245 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
 246 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
 247
 248 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h); /* deprecated */
 249
 250 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
 251 #define MSG_host_get_current_power_peak(h) MSG_host_get_speed(h) /* deprecated */
 252 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
 253 #define MSG_host_get_pstate(h)         sg_host_get_pstate(h)         /* deprecated */
 254 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* deprecated */
 255 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
 256 XBT_PUBLIC(int) MSG_get_host_number();
 257 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
 258 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
 259 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
 260
 261 /*property handlers*/
 262 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
 263 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
 264                                                      const char *name);
 265 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
 266
 267 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 268
 269 /************************** Process handling *********************************/
 270 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
 271                                            xbt_main_func_t code,
 272                                            void *data, msg_host_t host);
 273 XBT_PUBLIC(msg_process_t)
 274 MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
 275                                   char** argv);
 276 XBT_PUBLIC(msg_process_t)
 277 MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
 278                                     char** argv, xbt_dict_t properties);
 279
 280 XBT_PUBLIC(msg_process_t) MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
 281 XBT_PUBLIC(void) MSG_process_detach();
 282
 283 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
 284 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 285 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
 286 XBT_PUBLIC(void) MSG_process_yield();
 287
 288 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
 289 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
 290                                              void *data);
 291 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 292 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
 293 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
 294 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
 295 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
 296 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
 297 XBT_PUBLIC(int) MSG_process_self_PID();
 298 XBT_PUBLIC(int) MSG_process_self_PPID();
 299 XBT_PUBLIC(msg_process_t) MSG_process_self();
 300 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar();
 301 XBT_PUBLIC(int) MSG_process_get_number();
 302
 303 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
 304
 305 /*property handlers*/
 306 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
 307 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
 308                                                         process,
 309                                                         const char *name);
 310
 311 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
 312 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
 313 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
 314 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
 315 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 316
 317 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process);
 318 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
 319 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
 320 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
 321
 322 /************************** Task handling ************************************/
 323 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
 324                                      double flops_amount,
 325                                      double bytes_amount, void *data);
 326 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
 327                                               int host_nb,
 328                                               const msg_host_t * host_list,
 329                                               double *flops_amount,
 330                                               double *bytes_amount,
 331                                               void *data);
 332 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
 333 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
 334 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
 335     msg_task_t task, msg_process_t src, msg_process_t dst));
 336 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
 337 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
 338 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
 339 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
 340 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
 341 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
 342
 343 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
 344 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
 345 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
 346 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
 347 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
 348
 349 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
 350 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 351
 352 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
 353                                                double flops_amount);
 354 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
 355 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
 356                                         double bytes_amount);
 357
 358 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
 359 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 360 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
 361
 362
 363 XBT_PUBLIC(msg_error_t)
 364     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
 365                      msg_host_t host);
 366
 367 XBT_PUBLIC(msg_error_t)
 368     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
 369                               double timeout);
 370
 371 XBT_PUBLIC(msg_error_t)
 372     MSG_task_receive(msg_task_t * task, const char *alias);
 373 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 374
 375
 376
 377 XBT_PUBLIC(msg_error_t)
 378     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
 379                      msg_host_t host, double rate);
 380
 381 XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,  double timeout, double rate);
 382 XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
 383 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
 384
 385 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
 386 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
 387 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task, const char *alias,
 388     int (*match_fun)(void*,void*, smx_activity_t), void *match_data);
 389
 390 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
 391 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
 392 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
 393 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
 394 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
 395 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 396 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 397 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 398 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout);
 399 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 400 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
 401 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
 402
 403 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 404 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout);
 405 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate);
 406 XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias);
 407 XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
 408 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 409 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 410 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 411
 412 /************************** Mailbox handling ************************************/
 413
 414 /* @brief MSG_mailbox_set_async - set a mailbox as eager
 415  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
 416  * is issued, without waiting for the corresponding receive.
 417  * This call should be done before issuing any receive, and on the receiver's side only
 418  * @param alias    The alias of the mailbox to modify.
 419  */
 420 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
 421
 422 /************************** Action handling **********************************/
 423 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 424 XBT_PUBLIC(void) MSG_action_init();
 425 XBT_PUBLIC(void) MSG_action_exit();
 426
 427 /** @brief Opaque type representing a semaphore
 428  *  @ingroup msg_synchro
 429  *  @hideinitializer
 430  */
 431 typedef struct s_smx_sem *msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be declared here
 432 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
 433 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
 434 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 435 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
 436 XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
 437 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
 438 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
 439
 440 /** @brief Opaque type representing a barrier identifier
 441  *  @ingroup msg_synchro
 442  *  @hideinitializer
 443  */
 444
 445 #define MSG_BARRIER_SERIAL_PROCESS -1
 446 typedef struct s_msg_bar* msg_bar_t;
 447 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
 448 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
 449 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
 450
 451 /** @brief Opaque type describing a Virtual Machine.
 452  *  @ingroup msg_VMs
 453  *
 454  * All this is highly experimental and the interface will probably change in the future.
 455  * Please don't depend on this yet (although testing is welcomed if you feel so).
 456  * Usual lack of guaranty of any kind applies here, and is even increased.
 457  *
 458  */
 459
 460 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
 461 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
 462 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
 463 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
 464
 465 #define MSG_vm_get_name(vm) MSG_host_get_name(vm)
 466
 467 XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params);
 468 XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params);
 469
 470 // TODO add VDI later
 471 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
 472 XBT_PUBLIC(msg_vm_t)
 473 MSG_vm_create(msg_host_t ind_pm, const char* name, int ramsize, int mig_netspeed, int dp_intensity);
 474
 475 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 476
 477 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
 478
 479 /* Shutdown the guest operating system. */
 480 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
 481
 482 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
 483
 484 /* Suspend the execution of the VM, but keep its state on memory. */
 485 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
 486 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
 487
 488 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
 489 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
 490
 491
 492 #include "simgrid/instr.h"
 493
 494 /* ****************************************************************************************** */
 495 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 496 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 497
 498
 499 /* Functions renamed in 3.14 */
 500 #define MSG_mailbox_get_head(m) MSG_mailbox_front(m)
 501
 502
 503 SG_END_DECL()
 504
 505 #ifdef __cplusplus
 506 XBT_PUBLIC(msg_process_t)
 507 MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
 508                                 xbt_dict_t properties);
 509 #endif
 510
 511 #endif