1 /* Copyright (c) 2007-2019. 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 /* ******************************** Host ************************************ */
21 /** @brief Host datatype
22 @ingroup simix_host_management
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
31 @see m_host_management
40 SIMIX_SRC_HOST_FAILURE,
41 SIMIX_DST_HOST_FAILURE,
49 /* ****************************** Process *********************************** */
54 } smx_process_exit_status_t;
57 /******************************* Networking ***********************************/
58 extern unsigned smx_context_stack_size;
59 extern unsigned smx_context_guard_size;
63 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
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();
75 /********************************** Global ************************************/
76 /* Initialization and exit */
77 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
79 /* Set to execute in the maestro
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);
85 /* Simulation execution */
86 XBT_PUBLIC void SIMIX_run();
87 XBT_PUBLIC double SIMIX_get_clock();
89 /* Timer functions FIXME: should these be public? */
90 typedef struct s_smx_timer_t* smx_timer_t;
92 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
93 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
94 XBT_PUBLIC double SIMIX_timer_next();
95 XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer);
97 XBT_PUBLIC void SIMIX_display_process_status();
100 /******************************* Environment **********************************/
102 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC
103 void SIMIX_create_environment(const char* file);
106 /******************************** Deployment **********************************/
108 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC
109 void SIMIX_function_register(const char* name, xbt_main_func_t code);
110 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC
111 void SIMIX_launch_application(const char* file);
112 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
114 XBT_PUBLIC void SIMIX_init_application();
115 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
116 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
120 XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
121 XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
122 XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
125 /*********************************** Host *************************************/
126 /* Functions for running a process in main()
128 * 1. create the maestro process
129 * 2. attach (create a context and wait for maestro to give control back to you)
130 * 3. do you process job
131 * 4. detach (this waits for the simulation to terminate)
135 XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
136 std::unordered_map<std::string, std::string>* properties,
137 smx_actor_t parent_process);
140 XBT_PUBLIC void SIMIX_process_detach();
143 /********************************* Process ************************************/
145 XBT_PUBLIC int SIMIX_process_count();
146 XBT_PUBLIC smx_actor_t SIMIX_process_self();
147 XBT_PUBLIC const char* SIMIX_process_self_get_name();
148 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
149 XBT_PUBLIC void* SIMIX_process_self_get_data();
150 XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process);
151 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
155 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data);
158 /****************************** Communication *********************************/
159 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t));
160 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
161 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
163 XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
165 /******************************************************************************/
167 /******************************************************************************/
168 /* These functions are a system call-like interface to the simulation kernel. */
169 /* They can also be called from maestro's context, and they are thread safe. */
170 /******************************************************************************/
172 /******************************* Host simcalls ********************************/
174 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb,
175 const sg_host_t* host_list, const double* flops_amount,
176 const double* bytes_amount, double rate, double timeout);
178 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
179 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
181 /**************************** Process simcalls ********************************/
183 XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC
184 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
186 void simcall_process_set_data(smx_actor_t process, void* data);
187 /* Process handling */
188 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
189 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
192 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
195 /************************** Comunication simcalls *****************************/
198 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
199 size_t src_buff_size,
200 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
201 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
203 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
204 void* src_buff, size_t src_buff_size,
205 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
206 void (*clean_fun)(void*),
207 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
210 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
211 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
212 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout,
215 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
216 size_t* dst_buff_size,
217 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
218 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
221 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
222 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
226 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
227 XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout);
228 XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout);
229 XBT_PUBLIC int simcall_comm_test(smx_activity_t comm);
230 XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count);
232 /************************** Synchro simcalls **********************************/
234 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
235 XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex);
236 XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex);
237 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
238 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
239 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
241 XBT_PUBLIC smx_cond_t simcall_cond_init();
242 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
243 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
245 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
246 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
248 /***************************** Io **************************************/
249 XBT_PUBLIC e_smx_state_t simcall_io_wait(smx_activity_t io);
250 /************************** MC simcalls **********************************/
251 XBT_PUBLIC int simcall_mc_random(int min, int max);
253 /***************************** DEPRECATED CALLS ****************************/
254 XBT_ATTRIB_DEPRECATED_v325("Please use sg_actor_set_kill_time()") XBT_PUBLIC
255 void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
257 XBT_ATTRIB_DEPRECATED_v325("Please use Comm::cancel()") XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
259 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::cancel()") XBT_PUBLIC
260 void simcall_execution_cancel(smx_activity_t execution);
261 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_priority()") XBT_PUBLIC
262 void simcall_execution_set_priority(smx_activity_t execution, double priority);
263 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_bound()") XBT_PUBLIC
264 void simcall_execution_set_bound(smx_activity_t execution, double bound);
268 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::start()") XBT_PUBLIC smx_activity_t
269 simcall_execution_start(const std::string& name, const std::string& category, double flops_amount, double priority,
270 double bound, sg_host_t host);