Logo AND Algorithmique Numérique Distribuée

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