1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_SIMIX_H
7 #define SIMGRID_SIMIX_H
9 #include <simgrid/forward.h>
10 #include <xbt/dynar.h>
12 #include <xbt/parmap.h>
16 #include <unordered_map>
20 /******************************* Networking ***********************************/
21 extern unsigned smx_context_stack_size;
22 extern unsigned smx_context_guard_size;
26 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
29 XBT_PUBLIC int SIMIX_context_is_parallel();
30 XBT_PUBLIC int SIMIX_context_get_nthreads();
31 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
32 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
33 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
34 XBT_PUBLIC int SIMIX_is_maestro();
36 /********************************** Global ************************************/
37 /* Initialization and exit */
38 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
40 /* Set some code to execute in the maestro (must be used before the engine creation)
42 * If no maestro code is registered (the default), the main thread
43 * is assumed to be the maestro. */
44 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
46 /* Simulation execution */
47 XBT_PUBLIC void SIMIX_run();
48 XBT_PUBLIC double SIMIX_get_clock();
50 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
51 SIMIX_timer_set(double date, void (*function)(void*), void* arg);
52 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
53 void SIMIX_timer_remove(smx_timer_t timer);
54 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
55 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
56 double SIMIX_timer_get_date(smx_timer_t timer);
58 XBT_ATTRIB_DEPRECATED_v329("Please use simix_global->display_all_actor_status()") XBT_PUBLIC
59 void SIMIX_display_process_status();
62 /******************************** Deployment **********************************/
64 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC
65 void SIMIX_function_register_default(xbt_main_func_t code);
66 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application();
68 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
69 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
73 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
74 void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
75 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
76 void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
77 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC
78 void SIMIX_launch_application(const std::string& file);
81 /********************************* Process ************************************/
83 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_count()") XBT_PUBLIC int SIMIX_process_count();
84 XBT_PUBLIC smx_actor_t SIMIX_process_self();
85 XBT_PUBLIC const char* SIMIX_process_self_get_name();
86 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
87 void SIMIX_process_self_set_data(void* data);
88 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data();
92 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
93 void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
96 /****************************** Communication *********************************/
98 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
100 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
102 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
106 /******************************************************************************/
108 /******************************************************************************/
109 /* These functions are a system call-like interface to the simulation kernel. */
110 /* They can also be called from maestro's context, and they are thread safe. */
111 /******************************************************************************/
113 /******************************* Host simcalls ********************************/
115 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
116 simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout);
117 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
118 simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout);
119 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
121 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
122 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution);
123 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
124 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution);
128 /**************************** Process simcalls ********************************/
130 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process,
132 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_suspend()") XBT_PUBLIC
133 void simcall_process_suspend(smx_actor_t process);
135 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_join()") XBT_PUBLIC
136 void simcall_process_join(smx_actor_t process, double timeout);
138 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC
140 simgrid::kernel::activity::State
142 enum kernel_activity_state
144 simcall_process_sleep(double duration);
147 /************************** Communication simcalls ****************************/
150 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
151 size_t src_buff_size,
152 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
153 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
154 void* data, double timeout);
156 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
157 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
158 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
159 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
160 void* data, bool detached);
162 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
163 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
164 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
165 void* data, double timeout, double rate);
167 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
168 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
169 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
170 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
172 XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
173 simcall_comm_iprobe(smx_mailbox_t mbox, int type,
174 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
176 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
177 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout);
178 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
180 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
181 XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
182 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
183 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count);
184 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
186 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline void simcall_comm_wait(
187 const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout)
189 simcall_comm_wait(comm.get(), timeout);
191 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline bool simcall_comm_test(
192 const simgrid::kernel::activity::ActivityImplPtr& comm)
194 return simcall_comm_test(comm.get());
198 /************************** Synchro simcalls **********************************/
200 XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init();
201 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
202 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
203 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
205 XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init();
206 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
207 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
209 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
210 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
213 /***************************** Io **************************************/
215 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
216 simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout);
217 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
218 simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout);
219 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
220 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io);
221 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
222 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io);
224 /************************** MC simcalls **********************************/
226 XBT_PUBLIC int simcall_mc_random(int min, int max);