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, xbt_main_func_t code);
  26 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
  27 XBT_PUBLIC(void) MSG_launch_application(const char *file);
  28 XBT_PUBLIC(void) MSG_paje_output(const char *filename);
  29
  30 XBT_PUBLIC(double) MSG_get_clock(void);
  31 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
  32
  33
  34 /************************** Host handling ***********************************/
  35 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
  36 XBT_PUBLIC(void*) MSG_host_get_data(m_host_t host);
  37 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
  38 XBT_PUBLIC(m_host_t) MSG_host_self(void);
  39 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
  40 /* int MSG_get_msgload(void); This function lacks specification; discard it */
  41 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
  42 XBT_PUBLIC(int) MSG_host_is_avail (m_host_t h);
  43
  44 /*property handlers*/
  45 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
  46 XBT_PUBLIC(const char*) MSG_host_get_property_value(m_host_t host, const char* name);
  47
  48 XBT_PUBLIC(void) MSG_create_environment(const char *file);
  49
  50 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
  51 XBT_PUBLIC(int) MSG_get_host_number(void);
  52 XBT_PUBLIC(m_host_t *)MSG_get_host_table(void);
  53
  54 /************************** Process handling *********************************/
  55 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
  56                                xbt_main_func_t code, void *data,
  57                                m_host_t host);
  58 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
  59                                               xbt_main_func_t code, void *data,
  60                                               m_host_t host, int argc, char **argv);
  61 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
  62                                               xbt_main_func_t code, void *data,
  63                                               m_host_t host, int argc, char **argv, xbt_dict_t properties);
  64 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
  65 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
  66
  67 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
  68
  69 XBT_PUBLIC(void*) MSG_process_get_data(m_process_t process);
  70 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
  71 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
  72 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
  73 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
  74 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
  75 XBT_PUBLIC(const char *)MSG_process_get_name(m_process_t process);
  76 XBT_PUBLIC(int) MSG_process_self_PID(void);
  77 XBT_PUBLIC(int) MSG_process_self_PPID(void);
  78 XBT_PUBLIC(m_process_t) MSG_process_self(void);
  79
  80 /*property handlers*/
  81 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
  82 XBT_PUBLIC(const char*) MSG_process_get_property_value(m_process_t process, const char* name);
  83
  84 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
  85 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
  86 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
  87
  88 /************************** Task handling ************************************/
  89
  90 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name, double compute_duration,
  91                          double message_size, void *data);
  92 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
  93                                   int host_nb,
  94                                   const m_host_t *host_list,
  95                                   double *computation_amount,
  96                                   double *communication_amount,
  97                                   void *data);
  98 XBT_PUBLIC(void*) MSG_task_get_data(m_task_t task);
  99 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
 100 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
 101 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
 102 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
 103 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
 104
 105 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
 106 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
 107                                                    double max_duration);
 108 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
 109                                                m_host_t host);
 110 MSG_error_t
 111 MSG_task_receive_from_host(m_task_t * task, const char* alias, m_host_t host);
 112 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
 113                                          double max_duration, m_host_t host);
 114
 115
 116 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
 117                          m_channel_t channel);
 118 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
 119                                  m_host_t dest, m_channel_t channel,
 120                                  double max_rate);
 121 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
 122                                       m_channel_t channel, double max_duration);
 123 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
 124 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
 125 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
 126
 127 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
 128 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
 129 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
 130 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel, double max_duration,
 131                                     int *PID);
 132 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
 133 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
 134
 135 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
 136 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
 137 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
 138 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
 139
 140
 141 XBT_PUBLIC(MSG_error_t)
 142 MSG_task_receive_ext(m_task_t* task, const char* alias, double timeout, m_host_t host);
 143
 144 XBT_PUBLIC(MSG_error_t)
 145 MSG_task_receive_with_timeout(m_task_t * task, const char* alias, double timeout);
 146
 147 XBT_PUBLIC(MSG_error_t)
 148 MSG_task_receive(m_task_t * task, const char* alias);
 149
 150 XBT_PUBLIC(int)
 151 MSG_task_listen(const char* alias);
 152
 153 XBT_PUBLIC(int)
 154 MSG_task_listen_from_host(const char* alias, m_host_t host);
 155
 156 XBT_PUBLIC(MSG_error_t)
 157 MSG_alias_select_from(const char* alias, double timeout, int* PID);
 158
 159 XBT_PUBLIC(MSG_error_t)
 160 MSG_task_send_with_timeout(m_task_t task, const char* alias, double timeout);
 161
 162 XBT_PUBLIC(MSG_error_t)
 163 MSG_task_send(m_task_t task,const char* alias);
 164
 165 XBT_PUBLIC(MSG_error_t)
 166 MSG_task_send_bounded(m_task_t task, const char* alias, double rate);
 167
 168 XBT_PUBLIC(int)
 169 MSG_task_listen_from(const char* alias);
 170
 171 /************************** Task handling ************************************/
 172 XBT_PUBLIC(MSG_error_t)
 173 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t* task, m_host_t host, double timeout);
 174
 175 XBT_PUBLIC(MSG_error_t)
 176 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, double timeout);
 177
 178 SG_END_DECL()
 179 #endif