Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove includes of datatypes.h
[simgrid.git] / include / simgrid / simix.h
1 /* Copyright (c) 2007-2017. 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 _SIMIX_SIMIX_H
7 #define _SIMIX_SIMIX_H
8
9 #include "simgrid/forward.h"
10 #include "simgrid/host.h"
11 #include "xbt/ex.h"
12 #include "xbt/parmap.h"
13 #ifdef __cplusplus
14 #include <map>
15 #endif
16
17 /* ******************************** Host ************************************ */
18 /** @brief Host datatype
19     @ingroup simix_host_management
20
21     A <em>location</em> (or <em>host</em>) is any possible place where
22     a process may run. Thus it is represented as a <em>physical
23     resource with computing capabilities</em>, some <em>mailboxes</em>
24     to enable running process to communicate with remote ones, and
25     some <em>private data</em> that can be only accessed by local
26     process.
27
28     \see m_host_management
29   @{ */
30 typedef enum {
31   SIMIX_WAITING,
32   SIMIX_READY,
33   SIMIX_RUNNING,
34   SIMIX_DONE,
35   SIMIX_CANCELED,
36   SIMIX_FAILED,
37   SIMIX_SRC_HOST_FAILURE,
38   SIMIX_DST_HOST_FAILURE,
39   SIMIX_TIMEOUT,
40   SIMIX_SRC_TIMEOUT,
41   SIMIX_DST_TIMEOUT,
42   SIMIX_LINK_FAILURE
43 } e_smx_state_t;
44 /** @} */
45
46 /* ******************************** Synchro ************************************ */
47
48 /**
49  * \ingroup simix_synchro_management
50  */
51 typedef struct s_smx_cond_t* smx_cond_t;
52 /**
53  * \ingroup simix_synchro_management
54  */
55 typedef struct s_smx_sem_t* smx_sem_t;
56
57 /* ****************************** Process *********************************** */
58
59 typedef enum {
60   SMX_EXIT_SUCCESS = 0,
61   SMX_EXIT_FAILURE = 1
62 } smx_process_exit_status_t;
63 /** @} */
64
65 /******************************* Networking ***********************************/
66
67 /* Process creation/destruction callbacks */
68 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
69
70 extern unsigned smx_context_stack_size;
71 extern int smx_context_stack_size_was_set;
72 extern unsigned smx_context_guard_size;
73 extern int smx_context_guard_size_was_set;
74
75 SG_BEGIN_DECL()
76
77 XBT_PUBLIC(smx_actor_t) SIMIX_process_from_PID(aid_t PID);
78
79 /* parallelism */
80 XBT_PUBLIC(int) SIMIX_context_is_parallel();
81 XBT_PUBLIC(int) SIMIX_context_get_nthreads();
82 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
83 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
84 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
85 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode();
86 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
87 XBT_PUBLIC(int) SIMIX_is_maestro();
88
89
90 /********************************** Global ************************************/
91 /* Initialization and exit */
92 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
93
94 /* Set to execute in the maestro
95  *
96  * If no maestro code is registered (the default), the main thread
97  * is assumed to be the maestro. */
98 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
99
100 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
101 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
102
103 /* Simulation execution */
104 XBT_PUBLIC(void) SIMIX_run();
105 XBT_PUBLIC(double) SIMIX_get_clock();
106
107 /* Timer functions FIXME: should these be public? */
108 typedef struct s_smx_timer_t* smx_timer_t;
109
110 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
111 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
112 XBT_PUBLIC(double) SIMIX_timer_next();
113 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
114
115 XBT_PUBLIC(void) SIMIX_display_process_status();
116
117 /******************************* Environment **********************************/
118 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
119
120 /******************************** Deployment **********************************/
121
122 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
123 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
124 XBT_PUBLIC(void) SIMIX_init_application();
125 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
126
127 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
128                                             const char *process_function,
129                                             xbt_dynar_t arguments,
130                                             double process_start_time,
131                                             double process_kill_time);
132
133 /*********************************** Host *************************************/
134 /* Functions for running a process in main()
135  *
136  *  1. create the maestro process
137  *  2. attach (create a context and wait for maestro to give control back to you)
138  *  3. do you process job
139  *  4. detach (this waits for the simulation to terminate)
140  */
141
142 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
143 #ifdef __cplusplus
144 XBT_PUBLIC(smx_actor_t)
145 SIMIX_process_attach(const char* name, void* data, const char* hostname, std::map<std::string, std::string>* properties,
146                      smx_actor_t parent_process);
147 #endif
148 XBT_PUBLIC(void) SIMIX_process_detach();
149
150 /*********************************** Host *************************************/
151 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
152 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
153 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
154
155 /********************************* Process ************************************/
156 XBT_PUBLIC(int) SIMIX_process_count();
157 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
158 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
159 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
160 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
161 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
162 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
163 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
164
165 SG_END_DECL()
166
167 /****************************** Communication *********************************/
168 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t));
169 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
170 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
171
172 XBT_PUBLIC(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
173 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
174 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
175 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
176
177 /******************************************************************************/
178 /*                            SIMIX simcalls                                  */
179 /******************************************************************************/
180 /* These functions are a system call-like interface to the simulation kernel. */
181 /* They can also be called from maestro's context, and they are thread safe.  */
182 /******************************************************************************/
183
184 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
185
186 /******************************* Host simcalls ********************************/
187 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
188 XBT_PUBLIC(smx_activity_t)
189 simcall_execution_start(const char* name, double flops_amount, double priority, double bound, sg_host_t host);
190 XBT_PUBLIC(smx_activity_t)
191 simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
192                                  double* bytes_amount, double rate, double timeout);
193 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
194 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
195 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
196 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
197 XBT_PUBLIC(e_smx_state_t) simcall_execution_test(smx_activity_t execution);
198
199 /**************************** Process simcalls ********************************/
200 SG_BEGIN_DECL()
201 /* Constructor and Destructor */
202 #ifdef __cplusplus
203 XBT_PUBLIC(smx_actor_t)
204 simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc, char** argv,
205                        std::map<std::string, std::string>* properties);
206 #endif
207
208 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
209 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
210
211
212 /* Process handling */
213 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
214 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
215
216 /* Getters and Setters */
217 XBT_PUBLIC(int) simcall_process_count();
218 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
219 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
220 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
221 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
222 /* Sleep control */
223 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
224 SG_END_DECL()
225
226 /************************** Comunication simcalls *****************************/
227
228 #ifdef __cplusplus
229 XBT_PUBLIC(void)
230 simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
231                   size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
232                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
233
234 XBT_PUBLIC(smx_activity_t)
235 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
236                    size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
237                    void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
238                    int detached);
239
240 XBT_PUBLIC(void)
241 simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
242                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
243                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate);
244
245 XBT_PUBLIC(smx_activity_t)
246 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
247                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
248                    void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate);
249
250 XBT_PUBLIC(smx_activity_t)
251 simcall_comm_iprobe(smx_mailbox_t mbox, int type, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
252                     void* data);
253 #endif
254 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
255
256 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
257 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
258 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
259 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
260 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
261
262 /************************** Tracing handling **********************************/
263 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
264
265 /************************** Synchro simcalls **********************************/
266 SG_BEGIN_DECL()
267 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
268 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
269 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
270 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
271 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
272 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
273
274 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
275 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
276 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
277 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
278 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
279 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
280 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
281
282 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
283 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
284 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
285
286 /*****************************   Storage   **********************************/
287 XBT_PUBLIC(sg_size_t) simcall_storage_read(surf_storage_t st, sg_size_t size);
288 XBT_PUBLIC(sg_size_t) simcall_storage_write(surf_storage_t fd, sg_size_t size);
289 /************************** MC simcalls   **********************************/
290 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
291
292 SG_END_DECL()
293
294 #endif                          /* _SIMIX_SIMIX_H */