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/simix.h"
  13 #include "simgrid/platf.h"
  14
  15 SG_BEGIN_DECL()
  16
  17 /* ******************************** Mailbox ************************************ */
  18
  19 /** @brief Mailbox datatype
  20  *  @ingroup msg_task_usage
  21  *
  22  * Object representing a communication rendez-vous point, on which
  23  * the sender finds the receiver it wants to communicate with. As a
  24  * MSG user, you will only rarely manipulate any of these objects
  25  * directly, since most of the public interface (such as
  26  * #MSG_task_send and friends) hide this object behind a string
  27  * alias. That mean that you don't provide the mailbox on which you
  28  * want to send your task, but only the name of this mailbox. */
  29 typedef struct s_smx_rvpoint *msg_mailbox_t;
  30
  31 /* ******************************** Environment ************************************ */
  32 typedef struct As *msg_as_t;
  33
  34 /* ******************************** Host ************************************ */
  35
  36 /** @brief Host datatype.
  37     @ingroup m_host_management
  38
  39     A <em>location</em> (or <em>host</em>) is any possible place where
  40     a process may run. Thus it is represented as a <em>physical
  41     resource with computing capabilities</em>, some <em>mailboxes</em>
  42     to enable running process to communicate with remote ones, and
  43     some <em>private data</em> that can be only accessed by local
  44     process.
  45  */
  46 typedef sg_host_t msg_host_t;
  47
  48 typedef struct s_msg_host_priv {
  49   int        dp_enabled;
  50   xbt_dict_t dp_objs;
  51   double     dp_updated_by_deleted_tasks;
  52   int        is_migrating;
  53
  54   xbt_dict_t affinity_mask_db;
  55
  56 #ifdef MSG_USE_DEPRECATED
  57   msg_mailbox_t *mailboxes;     /**< the channels  */
  58 #endif
  59 } s_msg_host_priv_t;
  60
  61 /* ******************************** Task ************************************ */
  62
  63 typedef struct simdata_task *simdata_task_t;
  64
  65 typedef struct msg_task {
  66   char *name;                   /**< @brief task name if any */
  67   simdata_task_t simdata;       /**< @brief simulator data */
  68   void *data;                   /**< @brief user data */
  69   long long int counter;        /* task unique identifier for instrumentation */
  70   char *category;               /* task category for instrumentation */
  71 } s_msg_task_t;
  72
  73 /** @brief Task datatype.
  74     @ingroup m_task_management
  75
  76     A <em>task</em> may then be defined by a <em>computing
  77     amount</em>, a <em>message size</em> and some <em>private
  78     data</em>.
  79  */
  80 typedef struct msg_task *msg_task_t;
  81
  82 /* ******************************** VM ************************************* */
  83 typedef msg_host_t msg_vm_t;
  84
  85 /** ******************************** File ************************************ */
  86
  87 /** @brief File datatype.
  88 *  @ingroup msg_file_management
  89 *
  90 *  You should consider this as an opaque object.
  91 */
  92 typedef xbt_dictelm_t msg_file_t;
  93 typedef s_xbt_dictelm_t s_msg_file_t;
  94
  95 extern int MSG_FILE_LEVEL;
  96 typedef struct simdata_file *simdata_file_t;
  97
  98 typedef struct msg_file_priv  {
  99   char *fullpath;
 100   sg_size_t size;
 101   char* mount_point;
 102   char* storageId;
 103   char* storage_type;
 104   char* content_type;
 105   void *data;
 106   simdata_file_t simdata;
 107 } s_msg_file_priv_t, *msg_file_priv_t;
 108
 109 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
 110   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
 111 }
 112
 113 /* ******************************** Storage ************************************ */
 114 /* TODO: PV: to comment */
 115
 116 extern int MSG_STORAGE_LEVEL;
 117
 118 /** @brief Storage datatype.
 119  *  @ingroup msg_storage_management
 120  *
 121  *  You should consider this as an opaque object.
 122  */
 123 typedef xbt_dictelm_t msg_storage_t;
 124 typedef s_xbt_dictelm_t s_msg_storage_t;
 125
 126 typedef struct msg_storage_priv  {
 127   const char *hostname;
 128   void *data;
 129 } s_msg_storage_priv_t, *msg_storage_priv_t;
 130
 131 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
 132   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
 133 }
 134
 135 /*************** Begin GPU ***************/
 136 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 137
 138 typedef struct msg_gpu_task {
 139   char *name;                   /**< @brief task name if any */
 140   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 141   long long int counter;        /* task unique identifier for instrumentation */
 142   char *category;               /* task category for instrumentation */
 143 } s_msg_gpu_task_t;
 144
 145 /** @brief GPU task datatype.
 146     @ingroup m_task_management
 147
 148     A <em>task</em> may then be defined by a <em>computing
 149     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 150     \see m_task_management
 151 */
 152 typedef struct msg_gpu_task *msg_gpu_task_t;
 153 /*************** End GPU ***************/
 154
 155 /**
 156  * \brief @brief Communication action.
 157  * \ingroup msg_task_usage
 158  *
 159  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 160  */
 161 typedef struct msg_comm *msg_comm_t;
 162
 163 /** \brief Default value for an uninitialized #msg_task_t.
 164     \ingroup m_task_management
 165 */
 166 #define MSG_TASK_UNINITIALIZED NULL
 167
 168 /* ****************************** Process *********************************** */
 169
 170 /** @brief Process datatype.
 171     @ingroup m_process_management
 172
 173     A process may be defined as a <em>code</em>, with some
 174     <em>private data</em>, executing in a <em>location</em>.
 175
 176     You should not access directly to the fields of the pointed
 177     structure, but always use the provided API to interact with
 178     processes.
 179  */
 180 typedef struct s_smx_process *msg_process_t;
 181
 182 #ifdef MSG_USE_DEPRECATED
 183
 184 /* Compatibility typedefs */
 185 typedef int                     m_channel_t;
 186 typedef msg_gpu_task_t          m_gpu_task_t;
 187 typedef msg_host_t              m_host_t;
 188 typedef msg_process_t           m_process_t;
 189 typedef msg_task_t              m_task_t;
 190 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
 191 typedef s_msg_host_t            s_m_host_t;
 192 typedef s_msg_task_t            s_m_task_t;
 193 #endif
 194
 195 /** @brief Return code of most MSG functions
 196     @ingroup msg_simulation
 197     @{ */
 198 /* Keep these code as binary values: java bindings manipulate | of these values */
 199 typedef enum {
 200   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
 201   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
 202   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
 203       transfer. Either the network is down or the remote host has been
 204       shutdown. */
 205   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
 206       running has just been rebooted. Free your datastructures and
 207       return now !*/
 208   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 209 } msg_error_t;
 210 /** @} */
 211
 212 /************************** Global ******************************************/
 213 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
 214 /** \ingroup msg_simulation
 215  *  \brief Initialize the MSG internal data.
 216  *  \hideinitializer
 217  *
 218  *  It also check that the link-time and compile-time versions of SimGrid do
 219  *  match, so you should use this version instead of the #MSG_init_nocheck
 220  *  function that does the same initializations, but without this check.
 221  *
 222  *  We allow to link against compiled versions that differ in the patch level.
 223  */
 224 #define MSG_init(argc,argv)  {                                          \
 225     int ver_major,ver_minor,ver_patch;                                  \
 226     sg_version(&ver_major,&ver_minor,&ver_patch);                       \
 227     if ((ver_major != SIMGRID_VERSION_MAJOR) ||                         \
 228         (ver_minor != SIMGRID_VERSION_MINOR)) {                         \
 229       fprintf(stderr,"FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, and then linked against SimGrid %d.%d.%d. Please fix this.\n", \
 230               SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch); \
 231     }                                                                   \
 232     MSG_init_nocheck(argc,argv);                                        \
 233   }
 234
 235 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
 236 XBT_PUBLIC(msg_error_t) MSG_main(void);
 237 XBT_PUBLIC(void) MSG_function_register(const char *name,
 238                                        xbt_main_func_t code);
 239 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
 240 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
 241 XBT_PUBLIC(void) MSG_launch_application(const char *file);
 242 /*Bypass the parser */
 243 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
 244                                   const char *function_name,
 245                                   xbt_dynar_t arguments);
 246
 247 XBT_PUBLIC(double) MSG_get_clock(void);
 248 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
 249
 250 /************************** Environment ***********************************/
 251 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
 252 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
 253 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
 254 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
 255 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
 256 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
 257 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
 258
 259 /************************** File handling ***********************************/
 260 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
 261 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
 262 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
 263 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
 264 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
 265 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
 266 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
 267 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
 268 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
 269 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
 270 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
 271 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
 272 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
 273 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t storage);
 274 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
 275 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
 276 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
 277 /************************** Storage handling ***********************************/
 278 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
 279 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
 280 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
 281 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
 282 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
 283 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
 284 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
 285 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
 286 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
 287 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
 288 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
 289 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
 290 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
 291 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
 292 /************************** AS Router handling ************************************/
 293 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
 294 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
 295 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
 296
 297 /************************** Host handling ***********************************/
 298 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
 299 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
 300 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
 301 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 302 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
 303 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
 304 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
 305 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
 306 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
 307 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
 308 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 309 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
 310 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
 311 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
 312 XBT_PUBLIC(double) MSG_host_get_wattmin_at(msg_host_t host, int pstate);
 313 XBT_PUBLIC(double) MSG_host_get_wattmax_at(msg_host_t host, int pstate);
 314
 315 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
 316
 317 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
 318 XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h);
 319 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
 320 XBT_PUBLIC(void)   MSG_host_set_pstate(msg_host_t h, int pstate);
 321 XBT_PUBLIC(int)    MSG_host_get_pstate(msg_host_t host);
 322 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
 323 XBT_PUBLIC(int) MSG_get_host_number(void);
 324 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, ws_params_t params);
 325 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, ws_params_t params);
 326 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
 327 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
 328 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
 329
 330 XBT_PUBLIC(double) MSG_host_get_consumed_energy(msg_host_t h);
 331
 332 /*property handlers*/
 333 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
 334 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
 335                                                      const char *name);
 336 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
 337                                              const char *name, char *value,
 338                                              void_f_pvoid_t free_ctn);
 339
 340
 341 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 342
 343 /************************** Process handling *********************************/
 344 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
 345                                            xbt_main_func_t code,
 346                                            void *data, msg_host_t host);
 347 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
 348                                                           xbt_main_func_t
 349                                                           code, void *data,
 350                                                           msg_host_t host,
 351                                                           int argc,
 352                                                           char **argv);
 353 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
 354                                                             *name,
 355                                                             xbt_main_func_t
 356                                                             code,
 357                                                             void *data,
 358                                                             msg_host_t host,
 359                                                             int argc,
 360                                                             char **argv,
 361                                                             xbt_dict_t
 362                                                             properties);
 363 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
 364 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 365 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
 366
 367 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
 368 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
 369                                              void *data);
 370 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 371 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
 372 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
 373 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
 374 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
 375 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
 376 XBT_PUBLIC(int) MSG_process_self_PID(void);
 377 XBT_PUBLIC(int) MSG_process_self_PPID(void);
 378 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
 379 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
 380 XBT_PUBLIC(int) MSG_process_get_number(void);
 381
 382 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
 383
 384 /*property handlers*/
 385 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
 386 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
 387                                                         process,
 388                                                         const char *name);
 389
 390 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
 391 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
 392 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
 393 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
 394 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 395
 396 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
 397
 398 /************************** Task handling ************************************/
 399 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
 400                                      double flops_amount,
 401                                      double bytes_amount, void *data);
 402 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
 403                                      double flops_amount,
 404                                      double dispatch_latency,
 405                                      double collect_latency);
 406 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
 407                                               int host_nb,
 408                                               const msg_host_t * host_list,
 409                                               double *flops_amount,
 410                                               double *bytes_amount,
 411                                               void *data);
 412 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
 413 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
 414 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
 415     msg_task_t task, msg_process_t src, msg_process_t dst));
 416 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
 417 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
 418 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
 419 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
 420 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
 421 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
 422
 423 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
 424                                        msg_host_t host);
 425 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
 426                                        msg_host_t host, double rate);
 427
 428 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
 429 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
 430 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
 431 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
 432 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
 433
 434 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
 435 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 436
 437 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
 438                                                double flops_amount);
 439 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
 440 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
 441                                         double bytes_amount);
 442
 443 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
 444 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 445 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
 446
 447
 448 XBT_PUBLIC(msg_error_t)
 449     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
 450                      msg_host_t host);
 451
 452 XBT_PUBLIC(msg_error_t)
 453     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
 454                               double timeout);
 455
 456 XBT_PUBLIC(msg_error_t)
 457     MSG_task_receive(msg_task_t * task, const char *alias);
 458 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 459
 460
 461
 462 XBT_PUBLIC(msg_error_t)
 463     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
 464                      msg_host_t host, double rate);
 465
 466 XBT_PUBLIC(msg_error_t)
 467     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
 468                               double timeout, double rate);
 469
 470 XBT_PUBLIC(msg_error_t)
 471     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
 472 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
 473
 474 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
 475 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
 476 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
 477                                                     const char *alias,
 478                                                     int (*match_fun)(void*,void*, smx_synchro_t),
 479                                                     void *match_data);
 480
 481 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
 482 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
 483 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
 484 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
 485 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
 486 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 487 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 488 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 489 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
 490                                   double timeout);
 491 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 492 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
 493 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
 494
 495 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 496
 497 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
 498                                           msg_host_t host);
 499
 500 XBT_PUBLIC(msg_error_t)
 501     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
 502                            double timeout);
 503
 504 XBT_PUBLIC(msg_error_t)
 505     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
 506                            double timeout, double maxrate);
 507
 508 XBT_PUBLIC(msg_error_t)
 509     MSG_task_send(msg_task_t task, const char *alias);
 510
 511 XBT_PUBLIC(msg_error_t)
 512     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
 513
 514 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 515
 516 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 517 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 518
 519 /************************** Task handling ************************************/
 520 XBT_PUBLIC(msg_error_t)
 521     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
 522                          msg_host_t host, double timeout);
 523
 524 XBT_PUBLIC(msg_error_t)
 525     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
 526                                      msg_host_t host, double timeout, double rate);
 527
 528 XBT_PUBLIC(msg_error_t)
 529     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
 530                              double timeout);
 531
 532 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
 533
 534
 535 /************************** Action handling **********************************/
 536 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 537 XBT_PUBLIC(void) MSG_action_init(void);
 538 XBT_PUBLIC(void) MSG_action_exit(void);
 539
 540 #ifdef MSG_USE_DEPRECATED
 541
 542 typedef msg_error_t MSG_error_t;
 543
 544 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
 545 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
 546
 547 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
 548 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
 549
 550 #define MSG_host_is_avail(h) MSG_host_is_on(h)
 551
 552 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
 553 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
 554 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
 555         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
 556
 557 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
 558 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
 559
 560 XBT_PUBLIC(msg_error_t) MSG_clean(void);
 561
 562 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
 563 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
 564                                                   m_channel_t channel,
 565                                                   double max_duration);
 566 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
 567                                                int channel, msg_host_t host);
 568 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
 569                                          double max_duration,
 570                                          msg_host_t host);
 571 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
 572                                      m_channel_t channel);
 573 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
 574                                              msg_host_t dest,
 575                                              m_channel_t channel,
 576                                              double max_rate);
 577 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
 578                                                   msg_host_t dest,
 579                                                   m_channel_t channel,
 580                                                   double max_duration);
 581 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
 582 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
 583 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
 584
 585 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
 586 XBT_PUBLIC(int) MSG_get_channel_number(void);
 587 #endif
 588
 589 /** @brief Opaque type representing a semaphore
 590  *  @ingroup msg_synchro
 591  *  @hideinitializer
 592  */
 593 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
 594 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
 595 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
 596 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 597 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
 598 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
 599 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
 600 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
 601
 602 /** @brief Opaque type representing a barrier identifier
 603  *  @ingroup msg_synchro
 604  *  @hideinitializer
 605  */
 606
 607 #define MSG_BARRIER_SERIAL_PROCESS -1
 608 typedef struct s_xbt_bar *msg_bar_t;
 609 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
 610 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
 611 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
 612
 613 /** @brief Opaque type describing a Virtual Machine.
 614  *  @ingroup msg_VMs
 615  *
 616  * All this is highly experimental and the interface will probably change in the future.
 617  * Please don't depend on this yet (although testing is welcomed if you feel so).
 618  * Usual lack of guaranty of any kind applies here, and is even increased.
 619  *
 620  */
 621
 622 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
 623 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
 624 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
 625
 626 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
 627 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
 628 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
 629 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
 630
 631
 632 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
 633
 634 // TODO add VDI later
 635 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
 636 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
 637     int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
 638
 639 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 640
 641 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
 642
 643 /* Shutdown the guest operating system. */
 644 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
 645
 646 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
 647
 648 /* Suspend the execution of the VM, but keep its state on memory. */
 649 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
 650 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
 651
 652 /* Save the VM state to a disk. */
 653 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
 654 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
 655
 656 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
 657 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
 658 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
 659
 660 /* TODO: do we need this? */
 661 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
 662
 663 /*
 664 void* MSG_process_get_property(msg_process_t, char* key)
 665 void MSG_process_set_property(msg_process_t, char* key, void* data)
 666 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
 667
 668 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
 669 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
 670   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
 671   //                              <100 si c'est pas CPU intensive)
 672   // Contraintes à poser:
 673   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
 674   //   VM_coreAmount >= Load de toutes les tasks
 675 */
 676
 677   /*
 678 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
 679 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
 680 + des fonctions de filtrage sur les dynar
 681 */
 682 #include "simgrid/instr.h"
 683
 684
 685
 686 /* ****************************************************************************************** */
 687 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 688 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 689
 690 SG_END_DECL()
 691 #endif