1 /* Copyright (c) 2007-2021. 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_ATTRIB_DEPRECATED_v331("Please use sg_actor_by_PID instead.") XBT_PUBLIC smx_actor_t
27 SIMIX_process_from_PID(aid_t PID);
30 XBT_PUBLIC int SIMIX_context_is_parallel();
31 XBT_PUBLIC int SIMIX_context_get_nthreads();
32 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
33 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
34 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
35 XBT_PUBLIC int SIMIX_is_maestro();
37 /********************************** Global ************************************/
38 /* Initialization and exit */
39 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
41 /* Set some code to execute in the maestro (must be used before the engine creation)
43 * If no maestro code is registered (the default), the main thread
44 * is assumed to be the maestro. */
45 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
47 /* Simulation execution */
48 XBT_PUBLIC void SIMIX_run();
49 XBT_PUBLIC double SIMIX_get_clock();
51 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
52 SIMIX_timer_set(double date, void (*function)(void*), void* arg);
53 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
54 void SIMIX_timer_remove(smx_timer_t timer);
55 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
56 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
57 double SIMIX_timer_get_date(smx_timer_t timer);
59 XBT_ATTRIB_DEPRECATED_v329("Please use simix_global->display_all_actor_status()") XBT_PUBLIC
60 void SIMIX_display_process_status();
63 /******************************** Deployment **********************************/
65 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC
66 void SIMIX_function_register_default(xbt_main_func_t code);
67 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application();
69 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
70 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
74 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
75 void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
76 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
77 void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
78 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC
79 void SIMIX_launch_application(const std::string& file);
82 /********************************* Process ************************************/
84 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_count()") XBT_PUBLIC int SIMIX_process_count();
85 XBT_PUBLIC smx_actor_t SIMIX_process_self();
86 XBT_PUBLIC const char* SIMIX_process_self_get_name();
87 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
88 void SIMIX_process_self_set_data(void* data);
89 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data();
93 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
94 void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
97 /****************************** Communication *********************************/
99 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
101 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
103 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
107 /******************************************************************************/
109 /******************************************************************************/
110 /* These functions are a system call-like interface to the simulation kernel. */
111 /* They can also be called from maestro's context, and they are thread safe. */
112 /******************************************************************************/
114 /******************************* Host simcalls ********************************/
116 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
117 simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout);
118 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
119 simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout);
120 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
122 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
123 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution);
124 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
125 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution);
129 /**************************** Process simcalls ********************************/
131 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process,
133 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_suspend()") XBT_PUBLIC
134 void simcall_process_suspend(smx_actor_t process);
136 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_join()") XBT_PUBLIC
137 void simcall_process_join(smx_actor_t process, double timeout);
139 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC
141 simgrid::kernel::activity::State
143 enum kernel_activity_state
145 simcall_process_sleep(double duration);
148 /************************** Communication simcalls ****************************/
151 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
152 size_t src_buff_size,
153 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
154 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
155 void* data, double timeout);
157 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
158 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
159 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
160 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
161 void* data, bool detached);
163 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
164 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
165 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
166 void* data, double timeout, double rate);
168 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
169 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
170 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
171 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
173 XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
174 simcall_comm_iprobe(smx_mailbox_t mbox, int type,
175 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
177 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
178 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout);
179 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
181 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
182 XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
183 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
184 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count);
185 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
187 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline void simcall_comm_wait(
188 const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout)
190 simcall_comm_wait(comm.get(), timeout);
192 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline bool simcall_comm_test(
193 const simgrid::kernel::activity::ActivityImplPtr& comm)
195 return simcall_comm_test(comm.get());
199 /************************** Synchro simcalls **********************************/
201 XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init();
202 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
203 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
204 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
206 XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init();
207 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
208 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
210 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
211 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
214 /***************************** Io **************************************/
216 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
217 simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout);
218 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
219 simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout);
220 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
221 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io);
222 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
223 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io);
225 /************************** MC simcalls **********************************/
227 XBT_ATTRIB_DEPRECATED_v331("Please use MC_random") XBT_PUBLIC int simcall_mc_random(int min, int max);