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