1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
12 #include "msg/datatypes.h"
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 /*Bypass the parser */
30 XBT_PUBLIC(void) MSG_set_function(const char* host_id,const char *function_name,xbt_dynar_t arguments);
32 XBT_PUBLIC(double) MSG_get_clock(void);
33 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
36 /************************** Host handling ***********************************/
37 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
38 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
39 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
40 XBT_PUBLIC(m_host_t) MSG_host_self(void);
41 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
42 /* int MSG_get_msgload(void); This function lacks specification; discard it */
43 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
44 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
47 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
48 XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host,
51 XBT_PUBLIC(void) MSG_create_environment(const char *file);
52 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
54 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
55 XBT_PUBLIC(int) MSG_get_host_number(void);
56 XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
58 /************************** Process handling *********************************/
59 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
60 xbt_main_func_t code, void *data,
62 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
68 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
76 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
77 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
79 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
81 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
82 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
83 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
84 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
85 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
86 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
87 XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
88 XBT_PUBLIC(int) MSG_process_self_PID(void);
89 XBT_PUBLIC(int) MSG_process_self_PPID(void);
90 XBT_PUBLIC(m_process_t) MSG_process_self(void);
93 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
94 XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t process,
97 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
98 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
99 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
101 /************************** Task handling ************************************/
103 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
104 double compute_duration,
105 double message_size, void *data);
106 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, int host_nb,
107 const m_host_t * host_list,
108 double *computation_amount,
109 double *communication_amount,
111 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
112 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task,void*data);
113 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
114 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
115 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
116 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
117 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
119 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
120 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
122 double max_duration);
123 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
125 MSG_error_t MSG_task_receive_from_host(m_task_t * task,
126 const char *alias, m_host_t host);
127 XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
128 double max_duration, m_host_t host);
131 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
132 m_channel_t channel);
133 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
137 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
140 double max_duration);
141 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
142 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
143 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
145 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
146 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
147 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
148 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel,
151 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
152 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
154 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
155 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
156 XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task);
157 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
160 XBT_PUBLIC(MSG_error_t)
161 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
164 XBT_PUBLIC(MSG_error_t)
165 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
168 XBT_PUBLIC(MSG_error_t)
169 MSG_task_receive(m_task_t * task, const char *alias);
171 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
172 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
173 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
174 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
175 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm,double timeout);
176 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t *comm,int nb_elem, double timeout);
179 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
181 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host);
183 XBT_PUBLIC(MSG_error_t)
184 MSG_alias_select_from(const char *alias, double timeout, int *PID);
186 XBT_PUBLIC(MSG_error_t)
187 MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout);
189 XBT_PUBLIC(MSG_error_t)
190 MSG_task_send(m_task_t task, const char *alias);
192 XBT_PUBLIC(MSG_error_t)
193 MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
195 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
197 /************************** Task handling ************************************/
198 XBT_PUBLIC(MSG_error_t)
199 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
200 m_host_t host, double timeout);
202 XBT_PUBLIC(MSG_error_t)
203 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
206 /************************** Action handling **********************************/
207 typedef void (*msg_action_fun) (xbt_dynar_t args);
208 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
209 msg_action_fun function);
210 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
211 MSG_error_t MSG_action_trace_run(char *path);
214 #ifdef MSG_USE_DEPRECATED
215 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
216 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
217 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
218 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
222 #include "instr/instr.h"