3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
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. */
13 #include "msg/datatypes.h"
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);
31 XBT_PUBLIC(double) MSG_get_clock(void);
32 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
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);
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,
50 XBT_PUBLIC(void) MSG_create_environment(const char *file);
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);
56 /************************** Process handling *********************************/
57 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
58 xbt_main_func_t code, void *data,
60 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
66 XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name,
74 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
75 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
77 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
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);
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,
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);
99 /************************** Task handling ************************************/
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,
109 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
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);
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,
119 double max_duration);
120 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel,
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);
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,
134 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
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);
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,
148 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
149 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
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);
157 XBT_PUBLIC(MSG_error_t)
158 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
161 XBT_PUBLIC(MSG_error_t)
162 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
165 XBT_PUBLIC(MSG_error_t)
166 MSG_task_receive(m_task_t * task, const char *alias);
168 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
170 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host);
172 XBT_PUBLIC(MSG_error_t)
173 MSG_alias_select_from(const char *alias, double timeout, int *PID);
175 XBT_PUBLIC(MSG_error_t)
176 MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout);
178 XBT_PUBLIC(MSG_error_t)
179 MSG_task_send(m_task_t task, const char *alias);
181 XBT_PUBLIC(MSG_error_t)
182 MSG_task_send_bounded(m_task_t task, const char *alias, double rate);
184 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
186 /************************** Task handling ************************************/
187 XBT_PUBLIC(MSG_error_t)
188 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
189 m_host_t host, double timeout);
191 XBT_PUBLIC(MSG_error_t)
192 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
195 /************************** Action handling **********************************/
196 typedef void (*msg_action_fun) (xbt_dynar_t args);
197 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
198 msg_action_fun function);
199 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
200 MSG_error_t MSG_action_trace_run(char *path);
203 #ifdef MSG_USE_DEPRECATED
204 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
205 MSG_mailbox_put_with_timeout(mailbox, task, timeout)