include/msg/msg.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef MSG_H
   9 #define MSG_H
  10
  11 #include "xbt.h"
  12
  13 #include "msg/datatypes.h"
  14 SG_BEGIN_DECL()
  15
  16
  17 /************************** Global ******************************************/
  18 XBT_PUBLIC(void) MSG_config(const char *name, ...);
  19 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
  20 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
  21 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
  22 XBT_PUBLIC(int) MSG_get_channel_number(void);
  23 XBT_PUBLIC(MSG_error_t) MSG_main(void);
  24 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
  25 XBT_PUBLIC(void) MSG_function_register(const char *name,
  26                                        xbt_main_func_t code);
  27 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
  28 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
  29 XBT_PUBLIC(void) MSG_launch_application(const char *file);
  30 XBT_PUBLIC(void) MSG_paje_output(const char *filename);
  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
  53 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
  54 XBT_PUBLIC(int) MSG_get_host_number(void);
  55 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
  56
  57 /************************** Process handling *********************************/
  58 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
  59                                            xbt_main_func_t code, void *data,
  60                                            m_host_t host);
  61 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
  62                                                           xbt_main_func_t
  63                                                           code, void *data,
  64                                                           m_host_t host,
  65                                                           int argc,
  66                                                           char **argv);
  67 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
  68                                                             xbt_main_func_t
  69                                                             code, void *data,
  70                                                             m_host_t host,
  71                                                             int argc,
  72                                                             char **argv,
  73                                                             xbt_dict_t
  74                                                             properties);
  75 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
  76 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
  77
  78 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
  79
  80 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
  81 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
  82 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
  83 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
  84 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
  85 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
  86 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
  87 XBT_PUBLIC(int) MSG_process_self_PID(void);
  88 XBT_PUBLIC(int) MSG_process_self_PPID(void);
  89 XBT_PUBLIC(m_process_t) MSG_process_self(void);
  90
  91 /*property handlers*/
  92 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
  93 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t process,
  94                                                         const char *name);
  95
  96 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
  97 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
  98 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
  99
 100 /************************** Task handling ************************************/
 101
 102 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
 103                                      double compute_duration,
 104                                      double message_size, void *data);
 105 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, int host_nb,
 106                                               const m_host_t * host_list,
 107                                               double *computation_amount,
 108                                               double *communication_amount,
 109                                               void *data);
 110 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
 111 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
 112 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
 113 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
 114 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
 115 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
 116
 117 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
 118 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
 119                                                   m_channel_t channel,
 120                                                   double max_duration);
 121 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
 122                                                m_host_t host);
 123      MSG_error_t MSG_task_receive_from_host(m_task_t * task,
 124                                             const char *alias, m_host_t host);
 125 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
 126                                          double max_duration, m_host_t host);
 127
 128
 129 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
 130                                      m_channel_t channel);
 131 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
 132                                              m_host_t dest,
 133                                              m_channel_t channel,
 134                                              double max_rate);
 135 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
 136                                                   m_host_t dest,
 137                                                   m_channel_t channel,
 138                                                   double max_duration);
 139 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
 140 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
 141 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
 142
 143 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
 144 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
 145 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
 146 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel,
 147                                                 double max_duration,
 148                                                 int *PID);
 149 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
 150 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
 151
 152 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
 153 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
 154 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
 155 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
 156
 157
 158 XBT_PUBLIC(MSG_error_t)
 159   MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
 160                      m_host_t host);
 161
 162 XBT_PUBLIC(MSG_error_t)
 163   MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
 164                               double timeout);
 165
 166 XBT_PUBLIC(MSG_error_t)
 167   MSG_task_receive(m_task_t * task, const char *alias);
 168
 169 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 170
 171 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host);
 172
 173 XBT_PUBLIC(MSG_error_t)
 174   MSG_alias_select_from(const char *alias, double timeout, int *PID);
 175
 176 XBT_PUBLIC(MSG_error_t)
 177   MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout);
 178
 179 XBT_PUBLIC(MSG_error_t)
 180   MSG_task_send(m_task_t task, const char *alias);
 181
 182 XBT_PUBLIC(MSG_error_t)
 183   MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
 184
 185 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 186
 187 /************************** Task handling ************************************/
 188 XBT_PUBLIC(MSG_error_t)
 189   MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
 190                          m_host_t host, double timeout);
 191
 192 XBT_PUBLIC(MSG_error_t)
 193   MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 194                              double timeout);
 195
 196 /************************** Action handling **********************************/
 197      typedef void (*msg_action_fun) (xbt_dynar_t args);
 198 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
 199                                      msg_action_fun function);
 200 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
 201      MSG_error_t MSG_action_trace_run(char *path);
 202
 203
 204 #ifdef MSG_USE_DEPRECATED
 205 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
 206         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
 207
 208 #endif
 209
 210 SG_END_DECL()
 211 #endif