include/msg/msg.h

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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
  12 #include "msg/datatypes.h"
  13 SG_BEGIN_DECL()
  14
  15
  16 /************************** Global ******************************************/
  17 XBT_PUBLIC(void) MSG_config(const char *name, ...);
  18 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
  19 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
  20 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
  21 XBT_PUBLIC(int) MSG_get_channel_number(void);
  22 XBT_PUBLIC(MSG_error_t) MSG_main(void);
  23 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
  24 XBT_PUBLIC(void) MSG_function_register(const char *name,
  25                                        xbt_main_func_t code);
  26 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
  27 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
  28 XBT_PUBLIC(void) MSG_launch_application(const char *file);
  29 /*Bypass the parser */
  30 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
  31                                   const char *function_name,
  32                                   xbt_dynar_t arguments);
  33
  34 XBT_PUBLIC(double) MSG_get_clock(void);
  35 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
  36
  37
  38 /************************** Host handling ***********************************/
  39 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
  40 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
  41 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
  42 XBT_PUBLIC(m_host_t) MSG_host_self(void);
  43 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
  44 /* int MSG_get_msgload(void); This function lacks specification; discard it */
  45 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
  46 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
  47 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
  48
  49 /*property handlers*/
  50 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
  51 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
  52                                                      const char *name);
  53
  54 XBT_PUBLIC(void) MSG_create_environment(const char *file);
  55 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
  56
  57 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
  58 XBT_PUBLIC(int) MSG_get_host_number(void);
  59 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
  60
  61 /************************** Process handling *********************************/
  62 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
  63                                            xbt_main_func_t code,
  64                                            void *data, m_host_t host);
  65 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
  66                                                           xbt_main_func_t
  67                                                           code, void *data,
  68                                                           m_host_t host,
  69                                                           int argc,
  70                                                           char **argv);
  71 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
  72                                                             *name,
  73                                                             xbt_main_func_t
  74                                                             code,
  75                                                             void *data,
  76                                                             m_host_t host,
  77                                                             int argc,
  78                                                             char **argv,
  79                                                             xbt_dict_t
  80                                                             properties);
  81 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
  82 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
  83
  84 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
  85
  86 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
  87 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
  88                                              void *data);
  89 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
  90 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
  91 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
  92 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
  93 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
  94 XBT_PUBLIC(int) MSG_process_self_PID(void);
  95 XBT_PUBLIC(int) MSG_process_self_PPID(void);
  96 XBT_PUBLIC(m_process_t) MSG_process_self(void);
  97
  98 /*property handlers*/
  99 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
 100 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
 101                                                         process,
 102                                                         const char *name);
 103
 104 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
 105 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
 106 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
 107
 108 /************************** Task handling ************************************/
 109
 110 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
 111                                      double compute_duration,
 112                                      double message_size, void *data);
 113 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
 114                                               int host_nb,
 115                                               const m_host_t * host_list,
 116                                               double *computation_amount,
 117                                               double *communication_amount,
 118                                               void *data);
 119 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
 120 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
 121 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
 122 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
 123 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
 124 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
 125 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
 126 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
 127
 128 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
 129 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
 130                                                   m_channel_t channel,
 131                                                   double max_duration);
 132 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
 133                                                int channel, m_host_t host);
 134 MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
 135                                        m_host_t host);
 136 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
 137                                          double max_duration,
 138                                          m_host_t host);
 139
 140
 141 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
 142                                      m_channel_t channel);
 143 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
 144                                              m_host_t dest,
 145                                              m_channel_t channel,
 146                                              double max_rate);
 147 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
 148                                                   m_host_t dest,
 149                                                   m_channel_t channel,
 150                                                   double max_duration);
 151 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
 152 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
 153 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
 154
 155 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
 156 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
 157 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
 158 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
 159 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
 160
 161 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
 162 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
 163                                                double compute_duration);
 164 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
 165 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
 166 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
 167 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
 168
 169
 170 XBT_PUBLIC(MSG_error_t)
 171     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
 172                      m_host_t host);
 173
 174 XBT_PUBLIC(MSG_error_t)
 175     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
 176                               double timeout);
 177
 178 XBT_PUBLIC(MSG_error_t)
 179     MSG_task_receive(m_task_t * task, const char *alias);
 180 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
 181
 182 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
 183 XBT_INLINE XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, const char *alias,
 184                                                                int (*match_fun)(void*,void*),
 185                                                                void *match_data);
 186
 187 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
 188 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
 189 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
 190 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 191 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 192 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 193 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
 194                                   double timeout);
 195 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 196 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
 197 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
 198
 199 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 200
 201 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
 202                                           m_host_t host);
 203
 204 XBT_PUBLIC(MSG_error_t)
 205     MSG_task_send_with_timeout(m_task_t task, const char *alias,
 206                            double timeout);
 207
 208 XBT_PUBLIC(MSG_error_t)
 209     MSG_task_send(m_task_t task, const char *alias);
 210
 211 XBT_PUBLIC(MSG_error_t)
 212     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
 213
 214 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 215
 216 /************************** Task handling ************************************/
 217 XBT_PUBLIC(MSG_error_t)
 218     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
 219                          m_host_t host, double timeout);
 220
 221 XBT_PUBLIC(MSG_error_t)
 222     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 223                              double timeout);
 224
 225 /************************** Action handling **********************************/
 226 typedef void (*msg_action_fun) (const char *const *args);
 227 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
 228                                      msg_action_fun function);
 229 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
 230 MSG_error_t MSG_action_trace_run(char *path);
 231
 232 #ifdef MSG_USE_DEPRECATED
 233 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
 234 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
 235 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
 236 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
 237         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
 238
 239 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
 240 #endif
 241
 242 #include "instr/instr.h"
 243
 244 /* Used only by the bindings */
 245 #include "simix/simix.h"
 246 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
 247
 248 SG_END_DECL()
 249 #endif