Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2fb6435b6a5cff00d442565635c342ef38d65ea4
[simgrid.git] / include / msg / msg.h
1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef MSG_H
7 #define MSG_H
8
9 #include "xbt.h"
10
11 #include "msg/datatypes.h"
12 #include "xbt/automaton.h"
13
14 #include "simgrid/simix.h"
15
16 SG_BEGIN_DECL()
17
18 /** @brief Return code of most MSG functions
19     @ingroup msg_simulation
20     @{ */
21 /* Keep these code as binary values: java bindings manipulate | of these values */
22 typedef enum {
23   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
24   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
25   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
26       transfer. Either the network is down or the remote host has been
27       shutdown. */
28   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
29       running has just been rebooted. Free your datastructures and
30       return now !*/
31   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
32 } MSG_error_t;
33 /** @} */
34
35
36 /************************** Global ******************************************/
37 XBT_PUBLIC(void) MSG_config(const char *name, ...);
38 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
39 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
40 XBT_PUBLIC(MSG_error_t) MSG_main(void);
41 XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
42 XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a);
43 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
44 XBT_PUBLIC(void) MSG_function_register(const char *name,
45                                        xbt_main_func_t code);
46 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
47 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
48 XBT_PUBLIC(void) MSG_launch_application(const char *file);
49 /*Bypass the parser */
50 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
51                                   const char *function_name,
52                                   xbt_dynar_t arguments);
53
54 XBT_PUBLIC(double) MSG_get_clock(void);
55 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
56
57
58 /************************** File handling ***********************************/
59 XBT_PUBLIC(size_t) MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t stream);
60 XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
61 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode);
62 XBT_PUBLIC(int) MSG_file_close(msg_file_t fp);
63 XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf);
64
65
66 /************************** Host handling ***********************************/
67 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
68 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
69 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
70 XBT_PUBLIC(m_host_t) MSG_host_self(void);
71 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
72 /* int MSG_get_msgload(void); This function lacks specification; discard it */
73 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
74 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
75 XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
76
77 /*property handlers*/
78 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
79 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
80                                                      const char *name);
81 XBT_PUBLIC(void) MSG_host_set_property_value(m_host_t host,
82                                              const char *name, char *value,
83                                              void_f_pvoid_t free_ctn);
84
85
86 XBT_PUBLIC(void) MSG_create_environment(const char *file);
87 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
88
89 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
90 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
91
92 /************************** Process handling *********************************/
93 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
94                                            xbt_main_func_t code,
95                                            void *data, m_host_t host);
96 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
97                                                           xbt_main_func_t
98                                                           code, void *data,
99                                                           m_host_t host,
100                                                           int argc,
101                                                           char **argv);
102 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
103                                                             *name,
104                                                             xbt_main_func_t
105                                                             code,
106                                                             void *data,
107                                                             m_host_t host,
108                                                             int argc,
109                                                             char **argv,
110                                                             xbt_dict_t
111                                                             properties);
112 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
113 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
114
115 XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
116
117 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
118 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
119                                              void *data);
120 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
121 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
122 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
123 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
124 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
125 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
126 XBT_PUBLIC(int) MSG_process_self_PID(void);
127 XBT_PUBLIC(int) MSG_process_self_PPID(void);
128 XBT_PUBLIC(m_process_t) MSG_process_self(void);
129 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
130 XBT_PUBLIC(MSG_error_t) MSG_process_set_kill_time(m_process_t process, double kill_time);
131
132 /*property handlers*/
133 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
134 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t
135                                                         process,
136                                                         const char *name);
137
138 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
139 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
140 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
141 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
142
143 /************************** Task handling ************************************/
144 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
145                                      double compute_duration,
146                                      double message_size, void *data);
147 XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name,
148                                      double compute_duration,
149                                      double dispatch_latency,
150                                      double collect_latency);
151 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
152                                               int host_nb,
153                                               const m_host_t * host_list,
154                                               double *computation_amount,
155                                               double *communication_amount,
156                                               void *data);
157 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
158 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
159 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
160     m_task_t task, m_process_t src, m_process_t dst));
161 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
162 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
163 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
164 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
165 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
166 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
167
168 XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(m_task_t * task, const char *alias,
169                                        m_host_t host);
170
171 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
172 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
173 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
174
175 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
176
177 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
178 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
179                                                double compute_duration);
180 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
181 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
182 XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task);
183 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
184
185
186 XBT_PUBLIC(MSG_error_t)
187     MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
188                      m_host_t host);
189
190 XBT_PUBLIC(MSG_error_t)
191     MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
192                               double timeout);
193
194 XBT_PUBLIC(MSG_error_t)
195     MSG_task_receive(m_task_t * task, const char *alias);
196 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
197
198 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
199 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task,
200                                                     const char *alias,
201                                                     int (*match_fun)(void*,void*, smx_action_t),
202                                                     void *match_data);
203
204 XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
205 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
206 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
207 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
208 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
209 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
210 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
211                                   double timeout);
212 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
213 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
214 XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
215
216 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
217
218 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
219                                           m_host_t host);
220
221 XBT_PUBLIC(MSG_error_t)
222     MSG_task_send_with_timeout(m_task_t task, const char *alias,
223                            double timeout);
224
225 XBT_PUBLIC(MSG_error_t)
226     MSG_task_send(m_task_t task, const char *alias);
227
228 XBT_PUBLIC(MSG_error_t)
229     MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
230
231 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
232
233 XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category);
234 XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task);
235
236 /************************** Task handling ************************************/
237 XBT_PUBLIC(MSG_error_t)
238     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
239                          m_host_t host, double timeout);
240
241 XBT_PUBLIC(MSG_error_t)
242     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
243                              double timeout);
244
245 /************************** Action handling **********************************/
246 MSG_error_t MSG_action_trace_run(char *path);
247
248 #ifdef MSG_USE_DEPRECATED
249 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
250 XBT_PUBLIC(int) MSG_get_host_number(void);
251 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
252
253 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
254 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
255 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
256         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
257
258 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
259 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
260
261 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
262 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
263                                                   m_channel_t channel,
264                                                   double max_duration);
265 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
266                                                int channel, m_host_t host);
267 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
268                                          double max_duration,
269                                          m_host_t host);
270 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
271                                      m_channel_t channel);
272 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
273                                              m_host_t dest,
274                                              m_channel_t channel,
275                                              double max_rate);
276 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
277                                                   m_host_t dest,
278                                                   m_channel_t channel,
279                                                   double max_duration);
280 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
281 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
282 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
283
284 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
285 XBT_PUBLIC(int) MSG_get_channel_number(void);
286 #endif
287
288 #include "instr/instr.h"
289
290 /** @brief Opaque type describing a Virtual Machine.
291  *  @ingroup msg_VMs
292  *
293  * All this is highly experimental and the interface will probably change in the future.
294  * Please don't depend on this yet (although testing is welcomed if you feel so).
295  * Usual lack of guaranty of any kind applies here, and is even increased.
296  *
297  */
298 typedef struct msg_vm *msg_vm_t;
299 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
300 XBT_PUBLIC(msg_vm_t) MSG_vm_start(m_host_t location, int coreAmount);
301
302 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
303 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
304
305 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, m_process_t process);
306 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, m_process_t process); // simple wrapper over process_kill
307
308 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, m_host_t destination);
309
310 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
311   // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
312
313 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);  // Simulate the fact of reading the processes from disk and resuming them
314   // \forall p in VM, MSG_process_resume(p) // unfreeze them
315
316 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
317
318 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
319
320 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
321
322 /*
323 void* MSG_process_get_property(msg_process_t, char* key)
324 void MSG_process_set_property(msg_process_t, char* key, void* data)
325 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
326
327 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
328 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
329   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
330   //                              <100 si c'est pas CPU intensive)
331   // Contraintes à poser:
332   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
333   //   VM_coreAmount >= Load de toutes les tasks
334 */
335
336   /*
337 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
338 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
339 + des fonctions de filtrage sur les dynar
340 */
341
342
343 /* ****************************************************************************************** */
344 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
345 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
346
347 SG_END_DECL()
348 #endif