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