Logo AND Algorithmique Numérique Distribuée

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