Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Deprecate C API for SIMIX timers.
[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_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
90     SIMIX_timer_set(double date, void (*function)(void*), void* arg);
91 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
92     void SIMIX_timer_remove(smx_timer_t timer);
93 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
94 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
95     double SIMIX_timer_get_date(smx_timer_t timer);
96
97 XBT_PUBLIC void SIMIX_display_process_status();
98 SG_END_DECL()
99
100 /******************************** Deployment **********************************/
101 SG_BEGIN_DECL()
102 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
103
104 XBT_PUBLIC void SIMIX_init_application();
105 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
106                                            xbt_dynar_t arguments, double process_start_time, double process_kill_time);
107 SG_END_DECL()
108
109 #ifdef __cplusplus
110 XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
111 XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
112 XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
113 #endif
114
115 /********************************* Process ************************************/
116 SG_BEGIN_DECL()
117 XBT_PUBLIC int SIMIX_process_count();
118 XBT_PUBLIC smx_actor_t SIMIX_process_self();
119 XBT_PUBLIC const char* SIMIX_process_self_get_name();
120 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
121 XBT_PUBLIC void* SIMIX_process_self_get_data();
122 SG_END_DECL()
123
124 #ifdef __cplusplus
125 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
126 #endif
127
128 /****************************** Communication *********************************/
129 #ifdef __cplusplus
130 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
131                                                                    size_t));
132 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
133                                                  size_t buff_size);
134 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
135                                                 size_t buff_size);
136 #endif
137
138 /******************************************************************************/
139 /*                            SIMIX simcalls                                  */
140 /******************************************************************************/
141 /* These functions are a system call-like interface to the simulation kernel. */
142 /* They can also be called from maestro's context, and they are thread safe.  */
143 /******************************************************************************/
144
145 /******************************* Host simcalls ********************************/
146 #ifdef __cplusplus
147 XBT_PUBLIC e_smx_state_t simcall_execution_wait(const smx_activity_t& execution);
148 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
149                                                       double timeout);
150 XBT_PUBLIC bool simcall_execution_test(const smx_activity_t& execution);
151 #endif
152
153 /**************************** Process simcalls ********************************/
154 SG_BEGIN_DECL()
155 void simcall_process_set_data(smx_actor_t process, void* data);
156 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::suspend()") XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
157
158 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::join()") XBT_PUBLIC
159     void simcall_process_join(smx_actor_t process, double timeout);
160
161 /* Sleep control */
162 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
163 SG_END_DECL()
164
165 /************************** Comunication simcalls *****************************/
166
167 #ifdef __cplusplus
168 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
169                                   size_t src_buff_size,
170                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
171                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
172                                   void* data, double timeout);
173
174 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
175                                              void* src_buff, size_t src_buff_size,
176                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
177                                              void (*clean_fun)(void*),
178                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
179                                              void* data, bool detached);
180
181 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
182                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
183                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
184                                   void* data, double timeout, double rate);
185
186 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
187                                              size_t* dst_buff_size,
188                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
189                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
190                                              void* data, double rate);
191
192 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
193                                               int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
194                                               void* data);
195
196 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
197 XBT_PUBLIC unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout);
198 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
199                                              double timeout);
200 XBT_PUBLIC void simcall_comm_wait(const smx_activity_t& comm, double timeout);
201 XBT_PUBLIC bool simcall_comm_test(const smx_activity_t& comm);
202 XBT_PUBLIC int simcall_comm_testany(smx_activity_t comms[], size_t count);
203 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
204 #endif
205
206 /************************** Synchro simcalls **********************************/
207 SG_BEGIN_DECL()
208 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
209 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
210 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
211 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
212
213 XBT_PUBLIC smx_cond_t simcall_cond_init();
214 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
215 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
216
217 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
218 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
219 SG_END_DECL()
220
221 /*****************************   Io   **************************************/
222 #ifdef __cplusplus
223 XBT_PUBLIC e_smx_state_t simcall_io_wait(const smx_activity_t& io);
224 #endif
225 /************************** MC simcalls   **********************************/
226 SG_BEGIN_DECL()
227 XBT_PUBLIC int simcall_mc_random(int min, int max);
228 SG_END_DECL()
229
230 #endif