Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
e5f195f969121a5f01f4e86151f47ad52a5f9951
[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 /******************************* Environment **********************************/
98 SG_BEGIN_DECL()
99 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC
100     void SIMIX_create_environment(const char* file);
101 SG_END_DECL()
102
103 /******************************** Deployment **********************************/
104 SG_BEGIN_DECL()
105 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC
106     void SIMIX_function_register(const char* name, xbt_main_func_t code);
107 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC
108     void SIMIX_launch_application(const char* file);
109 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
110
111 XBT_PUBLIC void SIMIX_init_application();
112 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
113                                            xbt_dynar_t arguments, double process_start_time, double process_kill_time);
114 SG_END_DECL()
115
116 #ifdef __cplusplus
117 XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
118 XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
119 XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
120 #endif
121
122 /*********************************** Host *************************************/
123 /* Functions for running a process in main()
124  *
125  *  1. create the maestro process
126  *  2. attach (create a context and wait for maestro to give control back to you)
127  *  3. do you process job
128  *  4. detach (this waits for the simulation to terminate)
129  */
130
131 #ifdef __cplusplus
132 XBT_ATTRIB_DEPRECATED_v325("Please use ActorImpl::attach() or sg_actor_attach()") XBT_PUBLIC smx_actor_t
133     SIMIX_process_attach(const char* name, void* data, const char* hostname,
134                          std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process);
135 #endif
136 SG_BEGIN_DECL()
137 XBT_ATTRIB_DEPRECATED_v325("Please use ActorImpl::detach() or sg_actor_detach()") XBT_PUBLIC
138     void SIMIX_process_detach();
139 SG_END_DECL()
140
141 /********************************* Process ************************************/
142 SG_BEGIN_DECL()
143 XBT_PUBLIC int SIMIX_process_count();
144 XBT_PUBLIC smx_actor_t SIMIX_process_self();
145 XBT_PUBLIC const char* SIMIX_process_self_get_name();
146 XBT_ATTRIB_DEPRECATED_v325("Please use ActorImpl::set_user_data()") XBT_PUBLIC
147     void SIMIX_process_self_set_data(void* data);
148 XBT_ATTRIB_DEPRECATED_v325("Please use ActorImpl::get_user_data()") XBT_PUBLIC void* SIMIX_process_self_get_data();
149 XBT_ATTRIB_DEPRECATED_v325("Please manifest if you actually need this function") XBT_PUBLIC
150     int SIMIX_process_has_pending_comms(smx_actor_t process);
151 XBT_ATTRIB_DEPRECATED_v325("Please use SIMIX_process_on_exit(smx_actor_t, const std::function<void(bool)>&)") XBT_PUBLIC
152     void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
153 SG_END_DECL()
154
155 #ifdef __cplusplus
156 XBT_ATTRIB_DEPRECATED_v325("Please use SIMIX_process_on_exit(smx_actor_t, const std::function<void(bool)>&)") XBT_PUBLIC
157     void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(int, void*)>& fun, void* data);
158 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
159 #endif
160
161 /****************************** Communication *********************************/
162 #ifdef __cplusplus
163 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
164                                                                    size_t));
165 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
166                                                  size_t buff_size);
167 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
168                                                 size_t buff_size);
169 #endif
170
171 XBT_ATTRIB_DEPRECATED_v325("Please use CommImpl::finish()") XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
172
173 /******************************************************************************/
174 /*                            SIMIX simcalls                                  */
175 /******************************************************************************/
176 /* These functions are a system call-like interface to the simulation kernel. */
177 /* They can also be called from maestro's context, and they are thread safe.  */
178 /******************************************************************************/
179
180 /******************************* Host simcalls ********************************/
181 #ifdef __cplusplus
182 XBT_PUBLIC e_smx_state_t simcall_execution_wait(const smx_activity_t& execution);
183 XBT_PUBLIC bool simcall_execution_test(const smx_activity_t& execution);
184 #endif
185
186 /**************************** Process simcalls ********************************/
187 SG_BEGIN_DECL()
188 XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC
189     void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
190
191 void simcall_process_set_data(smx_actor_t process, void* data);
192 /* Process handling */
193 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
194 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
195
196 /* Sleep control */
197 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
198 SG_END_DECL()
199
200 /************************** Comunication simcalls *****************************/
201
202 #ifdef __cplusplus
203 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
204                                   size_t src_buff_size,
205                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
206                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
207                                   void* data, double timeout);
208
209 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
210                                              void* src_buff, size_t src_buff_size,
211                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
212                                              void (*clean_fun)(void*),
213                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
214                                              void* data, bool detached);
215
216 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
217                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
218                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
219                                   void* data, double timeout, double rate);
220
221 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
222                                              size_t* dst_buff_size,
223                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
224                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
225                                              void* data, double rate);
226
227 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
228                                               int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
229                                               void* data);
230
231 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
232 XBT_PUBLIC unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout);
233 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
234                                              double timeout);
235 XBT_PUBLIC void simcall_comm_wait(const smx_activity_t& comm, double timeout);
236 XBT_PUBLIC int simcall_comm_test(const smx_activity_t& comm);
237 XBT_PUBLIC int simcall_comm_testany(smx_activity_t comms[], size_t count);
238 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
239 #endif
240
241 /************************** Synchro simcalls **********************************/
242 SG_BEGIN_DECL()
243 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
244 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
245 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
246 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
247
248 XBT_PUBLIC smx_cond_t simcall_cond_init();
249 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
250 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
251
252 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
253 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
254 SG_END_DECL()
255
256 /*****************************   Io   **************************************/
257 #ifdef __cplusplus
258 XBT_PUBLIC e_smx_state_t simcall_io_wait(const smx_activity_t& io);
259 #endif
260 /************************** MC simcalls   **********************************/
261 SG_BEGIN_DECL()
262 XBT_PUBLIC int simcall_mc_random(int min, int max);
263 SG_END_DECL()
264
265 /***************************** DEPRECATED CALLS ****************************/
266 SG_BEGIN_DECL()
267 XBT_ATTRIB_DEPRECATED_v325("Please use sg_actor_set_kill_time()") XBT_PUBLIC
268     void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
269
270 XBT_ATTRIB_DEPRECATED_v325("Please use Comm::cancel()") XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
271
272 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::cancel()") XBT_PUBLIC
273     void simcall_execution_cancel(smx_activity_t execution);
274 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_priority()") XBT_PUBLIC
275     void simcall_execution_set_priority(smx_activity_t execution, double priority);
276 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_bound()") XBT_PUBLIC
277     void simcall_execution_set_bound(smx_activity_t execution, double bound);
278 SG_END_DECL()
279
280 #ifdef __cplusplus
281 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::start()") XBT_PUBLIC smx_activity_t
282     simcall_execution_start(const std::string& name, const std::string& category, double flops_amount, double priority,
283                             double bound, sg_host_t host);
284
285 // Should be deprecated in v325 too but is still used in other deprecated calls
286 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb,
287                                                            const sg_host_t* host_list, const double* flops_amount,
288                                                            const double* bytes_amount, double rate, double timeout);
289 #endif
290
291 #endif