Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a MSG_task_set_data() 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,
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
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,
48                                                      const char *name);
49
50 XBT_PUBLIC(void) MSG_create_environment(const char *file);
51
52 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
53 XBT_PUBLIC(int) MSG_get_host_number(void);
54 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
55
56 /************************** Process handling *********************************/
57 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
58                                            xbt_main_func_t code, void *data,
59                                            m_host_t host);
60 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
61                                                           xbt_main_func_t
62                                                           code, void *data,
63                                                           m_host_t host,
64                                                           int argc,
65                                                           char **argv);
66 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
67                                                             xbt_main_func_t
68                                                             code, void *data,
69                                                             m_host_t host,
70                                                             int argc,
71                                                             char **argv,
72                                                             xbt_dict_t
73                                                             properties);
74 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
75 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
76
77 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
78
79 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
80 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
81 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
82 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
83 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
84 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
85 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
86 XBT_PUBLIC(int) MSG_process_self_PID(void);
87 XBT_PUBLIC(int) MSG_process_self_PPID(void);
88 XBT_PUBLIC(m_process_t) MSG_process_self(void);
89
90 /*property handlers*/
91 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
92 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t process,
93                                                         const char *name);
94
95 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
96 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
97 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
98
99 /************************** Task handling ************************************/
100
101 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
102                                      double compute_duration,
103                                      double message_size, void *data);
104 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, int host_nb,
105                                               const m_host_t * host_list,
106                                               double *computation_amount,
107                                               double *communication_amount,
108                                               void *data);
109 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
110 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task,void*data);
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 XBT_PUBLIC(void) MSG_task_ref(m_task_t t);
117
118 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
119 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
120                                                   m_channel_t channel,
121                                                   double max_duration);
122 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
123                                                m_host_t host);
124      MSG_error_t MSG_task_receive_from_host(m_task_t * task,
125                                             const char *alias, m_host_t host);
126 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
127                                          double max_duration, m_host_t host);
128
129
130 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
131                                      m_channel_t channel);
132 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
133                                              m_host_t dest,
134                                              m_channel_t channel,
135                                              double max_rate);
136 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
137                                                   m_host_t dest,
138                                                   m_channel_t channel,
139                                                   double max_duration);
140 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
141 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
142 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
143
144 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
145 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
146 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
147 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel,
148                                                 double max_duration,
149                                                 int *PID);
150 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
151 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
152
153 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
154 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
155 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
156 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
157
158
159 XBT_PUBLIC(MSG_error_t)
160   MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
161                      m_host_t host);
162
163 XBT_PUBLIC(MSG_error_t)
164   MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
165                               double timeout);
166
167 XBT_PUBLIC(MSG_error_t)
168   MSG_task_receive(m_task_t * task, const char *alias);
169
170 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
171
172 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host);
173
174 XBT_PUBLIC(MSG_error_t)
175   MSG_alias_select_from(const char *alias, double timeout, int *PID);
176
177 XBT_PUBLIC(MSG_error_t)
178   MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout);
179
180 XBT_PUBLIC(MSG_error_t)
181   MSG_task_send(m_task_t task, const char *alias);
182
183 XBT_PUBLIC(MSG_error_t)
184   MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
185
186 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
187
188 /************************** Task handling ************************************/
189 XBT_PUBLIC(MSG_error_t)
190   MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
191                          m_host_t host, double timeout);
192
193 XBT_PUBLIC(MSG_error_t)
194   MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
195                              double timeout);
196
197 /************************** Action handling **********************************/
198      typedef void (*msg_action_fun) (xbt_dynar_t args);
199 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
200                                      msg_action_fun function);
201 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
202      MSG_error_t MSG_action_trace_run(char *path);
203
204
205 #ifdef MSG_USE_DEPRECATED
206 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
207         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
208
209 #endif
210
211 SG_END_DECL()
212 #endif