Logo AND Algorithmique Numérique Distribuée

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