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 <simgrid/host.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 int SIMIX_context_get_parallel_threshold();
33 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
34 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
35 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
36 XBT_PUBLIC int SIMIX_is_maestro();
38 /********************************** Global ************************************/
39 /* Initialization and exit */
40 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
42 /* Set to execute in the maestro
44 * If no maestro code is registered (the default), the main thread
45 * is assumed to be the maestro. */
46 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
48 /* Simulation execution */
49 XBT_PUBLIC void SIMIX_run();
50 XBT_PUBLIC double SIMIX_get_clock();
52 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
53 SIMIX_timer_set(double date, void (*function)(void*), void* arg);
54 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
55 void SIMIX_timer_remove(smx_timer_t timer);
56 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
57 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
58 double SIMIX_timer_get_date(smx_timer_t timer);
60 XBT_ATTRIB_DEPRECATED_v329("Please use simix_global->display_all_actor_status()") XBT_PUBLIC
61 void SIMIX_display_process_status();
64 /******************************** Deployment **********************************/
66 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC
67 void SIMIX_function_register_default(xbt_main_func_t code);
68 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application();
70 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
71 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
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, void (*code)(std::vector<std::string>));
77 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
78 void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
79 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC
80 void SIMIX_launch_application(const std::string& file);
83 /********************************* Process ************************************/
85 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_get_actor_count()") XBT_PUBLIC int SIMIX_process_count();
86 XBT_PUBLIC smx_actor_t SIMIX_process_self();
87 XBT_PUBLIC const char* SIMIX_process_self_get_name();
88 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
89 void SIMIX_process_self_set_data(void* data);
90 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data();
94 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
95 void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
98 /****************************** Communication *********************************/
100 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
102 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
104 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
108 /******************************************************************************/
110 /******************************************************************************/
111 /* These functions are a system call-like interface to the simulation kernel. */
112 /* They can also be called from maestro's context, and they are thread safe. */
113 /******************************************************************************/
115 /******************************* Host simcalls ********************************/
117 XBT_PUBLIC e_smx_state_t simcall_execution_wait(const smx_activity_t& execution, double timeout);
118 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
120 XBT_PUBLIC bool simcall_execution_test(const smx_activity_t& execution);
123 /**************************** Process simcalls ********************************/
125 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process,
127 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::suspend()") XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
129 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::join()") XBT_PUBLIC
130 void simcall_process_join(smx_actor_t process, double timeout);
132 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC e_smx_state_t
133 simcall_process_sleep(double duration);
136 /************************** Communication simcalls ****************************/
139 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
140 size_t src_buff_size,
141 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
142 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
143 void* data, double timeout);
145 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
146 void* src_buff, size_t src_buff_size,
147 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
148 void (*clean_fun)(void*),
149 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
150 void* data, bool detached);
152 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_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, double rate);
157 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
158 size_t* dst_buff_size,
159 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
160 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
161 void* data, double rate);
163 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
164 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
167 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
168 XBT_PUBLIC unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout);
169 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
171 XBT_PUBLIC void simcall_comm_wait(const smx_activity_t& comm, double timeout);
172 XBT_PUBLIC bool simcall_comm_test(const smx_activity_t& comm);
173 XBT_PUBLIC int simcall_comm_testany(smx_activity_t comms[], size_t count);
174 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
177 /************************** Synchro simcalls **********************************/
179 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
180 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
181 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
182 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
184 XBT_PUBLIC smx_cond_t simcall_cond_init();
185 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
186 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
188 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
189 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
192 /***************************** Io **************************************/
194 XBT_PUBLIC e_smx_state_t simcall_io_wait(const smx_activity_t& io, double timeout);
195 XBT_PUBLIC bool simcall_io_test(const smx_activity_t& io);
197 /************************** MC simcalls **********************************/
199 XBT_PUBLIC int simcall_mc_random(int min, int max);