Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
afab0afcf4f374d8e5a44ee3468ae0c43382d6d7
[simgrid.git] / 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
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,
47                                                      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
61                                                           code, void *data,
62                                                           m_host_t host,
63                                                           int argc,
64                                                           char **argv);
65 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
66                                                             xbt_main_func_t
67                                                             code, void *data,
68                                                             m_host_t host,
69                                                             int argc,
70                                                             char **argv,
71                                                             xbt_dict_t
72                                                             properties);
73 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
74 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
75
76 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
77
78 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
79 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
80 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
81 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
82 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
83 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
84 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
85 XBT_PUBLIC(int) MSG_process_self_PID(void);
86 XBT_PUBLIC(int) MSG_process_self_PPID(void);
87 XBT_PUBLIC(m_process_t) MSG_process_self(void);
88
89 /*property handlers*/
90 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
91 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t process,
92                                                         const char *name);
93
94 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
95 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
96 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
97
98 /************************** Task handling ************************************/
99
100 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
101                                      double compute_duration,
102                                      double message_size, void *data);
103 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, int host_nb,
104                                               const m_host_t * host_list,
105                                               double *computation_amount,
106                                               double *communication_amount,
107                                               void *data);
108 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
109 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task,void*data);
110 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
111 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
112 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
113 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
114 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
115
116 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
117 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
118                                                   m_channel_t channel,
119                                                   double max_duration);
120 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
121                                                m_host_t host);
122      MSG_error_t MSG_task_receive_from_host(m_task_t * task,
123                                             const char *alias, m_host_t host);
124 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
125                                          double max_duration, m_host_t host);
126
127
128 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
129                                      m_channel_t channel);
130 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
131                                              m_host_t dest,
132                                              m_channel_t channel,
133                                              double max_rate);
134 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
135                                                   m_host_t dest,
136                                                   m_channel_t channel,
137                                                   double max_duration);
138 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
139 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
140 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
141
142 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
143 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
144 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
145 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel,
146                                                 double max_duration,
147                                                 int *PID);
148 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
149 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
150
151 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
152 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
153 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
154 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
155
156
157 XBT_PUBLIC(MSG_error_t)
158   MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
159                      m_host_t host);
160
161 XBT_PUBLIC(MSG_error_t)
162   MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
163                               double timeout);
164
165 XBT_PUBLIC(MSG_error_t)
166   MSG_task_receive(m_task_t * task, const char *alias);
167
168 XBT_PUBLIC(msg_comm_t)   MSG_task_isend(m_task_t task, const char *alias);
169 XBT_PUBLIC(msg_comm_t)   MSG_task_irecv(m_task_t * task, const char *alias);
170 XBT_PUBLIC(int)               MSG_comm_test(msg_comm_t comm);
171 XBT_PUBLIC(void)              MSG_comm_destroy(msg_comm_t comm);
172 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm,double timeout);
173
174
175 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
176
177 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host);
178
179 XBT_PUBLIC(MSG_error_t)
180   MSG_alias_select_from(const char *alias, double timeout, int *PID);
181
182 XBT_PUBLIC(MSG_error_t)
183   MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout);
184
185 XBT_PUBLIC(MSG_error_t)
186   MSG_task_send(m_task_t task, const char *alias);
187
188 XBT_PUBLIC(MSG_error_t)
189   MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
190
191 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
192
193 /************************** Task handling ************************************/
194 XBT_PUBLIC(MSG_error_t)
195   MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
196                          m_host_t host, double timeout);
197
198 XBT_PUBLIC(MSG_error_t)
199   MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
200                              double timeout);
201
202 /************************** Action handling **********************************/
203      typedef void (*msg_action_fun) (xbt_dynar_t args);
204 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
205                                      msg_action_fun function);
206 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
207      MSG_error_t MSG_action_trace_run(char *path);
208
209
210 #ifdef MSG_USE_DEPRECATED
211 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
212 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
213 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
214         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
215
216 #endif
217
218 #include "instr/instr.h"
219
220 SG_END_DECL()
221 #endif