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