Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
325a5df2966d8e72a17569ce8a5d622f30c9879d
[simgrid.git] / src / include / simix / simix.h
1 /* Copyright (c) 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 _SIMIX_SIMIX_H
8 #define _SIMIX_SIMIX_H
9
10 #include "xbt/misc.h"
11 #include "xbt/fifo.h"
12 #include "xbt/dict.h"
13 #include "xbt/function_types.h"
14 #include "simix/datatypes.h"
15 #include "surf/surf.h"
16
17 SG_BEGIN_DECL()
18
19
20 /************************** Global ******************************************/
21 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
22 XBT_PUBLIC(void) SIMIX_clean(void);
23 XBT_PUBLIC(void) SIMIX_function_register(const char *name,
24                                          xbt_main_func_t code);
25 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
26 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
27
28 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
29
30 /*
31  *  Deployment (Bypass the parser)
32  */
33 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,const char *process_function,xbt_dynar_t arguments,double process_start_time,double process_kill_time);
34
35
36 XBT_PUBLIC(double) SIMIX_get_clock(void);
37 XBT_PUBLIC(void) SIMIX_init(void);
38 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done,
39                                xbt_fifo_t actions_failed);
40
41 /* Timer functions */
42 XBT_PUBLIC(void) SIMIX_timer_set(double date, void *function, void *arg);
43 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
44
45 /* only for tests */
46 XBT_PUBLIC(void) __SIMIX_main(void);
47
48 /* User create and kill process, the function must accept the folling parameters:
49  * const char *name: a name for the object. It is for user-level information and can be NULL
50  * xbt_main_func_t code: is a function describing the behavior of the agent
51  * void *data: data a pointer to any data one may want to attach to the new object.
52  * smx_host_t host: the location where the new agent is executed
53  * int argc, char **argv: parameters passed to code
54  *
55  * */
56      typedef void *(*smx_creation_func_t) ( /*name */ const char *,
57                                            /*code */ xbt_main_func_t,
58                                            /*userdata */ void *,
59                                            /*hostname */ char *,
60                                            /* argc */ int,
61                                            /* argv */ char **,
62                                            /* props */ xbt_dict_t);
63 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t
64                                                         function);
65 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t
66                                                       function);
67 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t
68                                                          function);
69
70 /************************** Host handling ***********************************/
71
72 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
73 XBT_PUBLIC(void *) SIMIX_host_get_data(smx_host_t host);
74
75 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
76 XBT_PUBLIC(void) SIMIX_process_set_name(smx_process_t process, char *name);
77 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
78 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
79 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
80
81 XBT_PUBLIC(int) SIMIX_host_get_number(void);
82 XBT_PUBLIC(smx_host_t *) SIMIX_host_get_table(void);
83 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
84
85 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
86 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
87
88 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
89
90 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
91 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
92
93 /************************** Process handling *********************************/
94 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
95                                                xbt_main_func_t code,
96                                                void *data,
97                                                const char *hostname, int argc,
98                                                char **argv,
99                                                xbt_dict_t properties);
100
101 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
102 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
103 XBT_PUBLIC(void) SIMIX_process_killall(void);
104 XBT_PUBLIC(void) SIMIX_process_change_host(smx_process_t process,
105                                            char *source, char *dest);
106
107 //above layer
108 XBT_PUBLIC(void *) SIMIX_process_get_data(smx_process_t process);
109 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
110
111 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
112 XBT_PUBLIC(const char *) SIMIX_process_get_name(smx_process_t process);
113 XBT_INLINE XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
114
115 XBT_PUBLIC(void) SIMIX_process_yield(void);
116 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
117 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
118 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
119 XBT_PUBLIC(int) SIMIX_process_is_blocked(smx_process_t process);
120
121 /*property handlers*/
122 XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
123 XBT_PUBLIC(int) SIMIX_process_count(void);
124
125 /************************** Synchro handling **********************************/
126
127 /******Mutex******/
128 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
129 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
130 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
131 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
132 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
133
134 /*****Conditional*****/
135 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
136 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
137 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
138 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex,
139                                          double max_duration);
140 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
141 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
142 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
143 XBT_PUBLIC(void) SIMIX_cond_display_info(smx_cond_t cond);
144
145 /*****Semaphores*******/
146
147
148 XBT_PUBLIC(smx_sem_t) SIMIX_sem_init(int capacity);
149 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
150 XBT_PUBLIC(void) SIMIX_sem_release(smx_sem_t sem);
151 XBT_PUBLIC(void) SIMIX_sem_release_forever(smx_sem_t sem);
152 XBT_PUBLIC(int) SIMIX_sem_would_block(smx_sem_t sem);
153 XBT_PUBLIC(void) SIMIX_sem_block_onto(smx_sem_t sem);
154 XBT_PUBLIC(void) SIMIX_sem_acquire(smx_sem_t sem);
155 XBT_PUBLIC(void) SIMIX_sem_acquire_timeout(smx_sem_t sem, double max_duration);
156 XBT_PUBLIC(unsigned int) SIMIX_sem_acquire_any(xbt_dynar_t sems);
157 XBT_PUBLIC(int) SIMIX_sem_get_capacity(smx_sem_t sem);
158
159
160 /************************** Action handling ************************************/
161 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,
162                                                   smx_host_t receiver,
163                                                   const char *name,
164                                                   double size, double rate);
165 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,
166                                               const char *name,
167                                               double amount);
168 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
169 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
170 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action,
171                                            double priority);
172 XBT_PUBLIC(void) SIMIX_action_resume(smx_action_t action);
173 XBT_PUBLIC(void) SIMIX_action_suspend(smx_action_t action);
174 XBT_PUBLIC(int) SIMIX_action_destroy(smx_action_t action);
175 XBT_PUBLIC(void) SIMIX_action_use(smx_action_t action);
176 XBT_PUBLIC(void) SIMIX_action_release(smx_action_t action);
177
178 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action,
179                                                     smx_cond_t cond);
180 XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action,
181                                                       smx_cond_t cond);
182 XBT_PUBLIC(void) SIMIX_register_action_to_semaphore(smx_action_t action, smx_sem_t sem);
183 XBT_INLINE XBT_PUBLIC(void) SIMIX_unregister_action_to_semaphore(smx_action_t action, smx_sem_t sem);
184
185
186 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
187 XBT_PUBLIC(int) SIMIX_action_is_latency_bounded(smx_action_t action);
188
189 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
190
191 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char *name,
192                                                        int host_nb,
193                                                        smx_host_t * host_list,
194                                                        double
195                                                        *computation_amount, double
196                                                        *communication_amount,
197                                                        double amount,
198                                                        double rate);
199
200 XBT_PUBLIC(char *) SIMIX_action_get_name(smx_action_t action);
201 XBT_PUBLIC(void) SIMIX_action_set_name(smx_action_t action,char *name);
202 XBT_PUBLIC(void) SIMIX_action_signal_all(smx_action_t action);
203 XBT_PUBLIC(void) SIMIX_display_process_status(void);
204 /************************** Comunication Handling *****************************/
205
206 /* Public */
207 /*****Rendez-vous points*****/
208 XBT_PUBLIC(smx_rdv_t) SIMIX_rdv_create(const char *name);
209 XBT_PUBLIC(void) SIMIX_rdv_destroy(smx_rdv_t rvp);
210 XBT_PUBLIC(int) SIMIX_rdv_get_count_waiting_comm(smx_rdv_t rdv, smx_host_t host);
211 XBT_PUBLIC(smx_comm_t) SIMIX_rdv_get_head(smx_rdv_t rdv);
212 XBT_PUBLIC(smx_comm_t) SIMIX_rdv_get_request(smx_rdv_t rdv, smx_comm_type_t type);
213 XBT_PUBLIC(void) SIMIX_rdv_set_data(smx_rdv_t rdv,void *data);
214 XBT_PUBLIC(void*) SIMIX_rdv_get_data(smx_rdv_t rdv);
215
216 /*****Communication Requests*****/
217 XBT_INLINE XBT_PUBLIC(void) SIMIX_communication_cancel(smx_comm_t comm);
218 XBT_PUBLIC(void) SIMIX_communication_destroy(smx_comm_t comm);
219 XBT_PUBLIC(double) SIMIX_communication_get_remains(smx_comm_t comm);
220 XBT_PUBLIC(int)    SIMIX_communication_is_latency_bounded(smx_comm_t comm);
221 XBT_PUBLIC(void *) SIMIX_communication_get_data(smx_comm_t comm);
222
223 XBT_PUBLIC(void *) SIMIX_communication_get_src_buf(smx_comm_t comm);
224 XBT_PUBLIC(void *) SIMIX_communication_get_dst_buf(smx_comm_t comm);
225 XBT_PUBLIC(size_t) SIMIX_communication_get_src_buf_size(smx_comm_t comm);
226 XBT_PUBLIC(size_t) SIMIX_communication_get_dst_buf_size(smx_comm_t comm);
227
228 /*****Networking*****/
229 XBT_PUBLIC(void) SIMIX_network_set_copy_data_callback(void (*callback)(smx_comm_t, size_t));
230 XBT_PUBLIC(void) SIMIX_network_copy_pointer_callback(smx_comm_t comm, size_t buff_size);
231 XBT_PUBLIC(void) SIMIX_network_copy_buffer_callback(smx_comm_t comm, size_t buff_size);
232 XBT_PUBLIC(void) SIMIX_network_send(smx_rdv_t rdv, double task_size, double rate,
233                                     double timeout, void *src_buff,
234                                     size_t src_buff_size, smx_comm_t *comm, void *data);
235 XBT_PUBLIC(void) SIMIX_network_recv(smx_rdv_t rdv, double timeout, void *dst_buff,
236                                     size_t *dst_buff_size, smx_comm_t *comm);
237 XBT_PUBLIC(smx_comm_t) SIMIX_network_isend(smx_rdv_t rdv, double task_size, double rate,
238                                            void *src_buff, size_t src_buff_size, void *data);
239 XBT_PUBLIC(smx_comm_t) SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size);
240 XBT_PUBLIC(unsigned int) SIMIX_network_waitany(xbt_dynar_t comms);
241 XBT_INLINE XBT_PUBLIC(void) SIMIX_network_wait(smx_comm_t comm, double timeout);
242 XBT_PUBLIC(int) SIMIX_network_test(smx_comm_t comm);
243
244 SG_END_DECL()
245 #endif /* _SIMIX_SIMIX_H */