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 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
90 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
91 XBT_PUBLIC double SIMIX_timer_next();
92 XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer);
94 XBT_PUBLIC void SIMIX_display_process_status();
97 /******************************* Environment **********************************/
99 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC
100 void SIMIX_create_environment(const char* file);
103 /******************************** Deployment **********************************/
105 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC
106 void SIMIX_function_register(const char* name, xbt_main_func_t code);
107 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC
108 void SIMIX_launch_application(const char* file);
109 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
111 XBT_PUBLIC void SIMIX_init_application();
112 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
113 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
117 XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
118 XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
119 XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
122 /*********************************** Host *************************************/
123 /* Functions for running a process in main()
125 * 1. create the maestro process
126 * 2. attach (create a context and wait for maestro to give control back to you)
127 * 3. do you process job
128 * 4. detach (this waits for the simulation to terminate)
132 XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
133 std::unordered_map<std::string, std::string>* properties,
134 smx_actor_t parent_process);
137 XBT_PUBLIC void SIMIX_process_detach();
140 /********************************* Process ************************************/
142 XBT_PUBLIC int SIMIX_process_count();
143 XBT_PUBLIC smx_actor_t SIMIX_process_self();
144 XBT_PUBLIC const char* SIMIX_process_self_get_name();
145 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
146 XBT_PUBLIC void* SIMIX_process_self_get_data();
147 XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process);
148 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
152 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data);
155 /****************************** Communication *********************************/
156 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t));
157 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
158 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
160 XBT_ATTRIB_DEPRECATED_v325("Please use CommImpl::finish") XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
162 /******************************************************************************/
164 /******************************************************************************/
165 /* These functions are a system call-like interface to the simulation kernel. */
166 /* They can also be called from maestro's context, and they are thread safe. */
167 /******************************************************************************/
169 /******************************* Host simcalls ********************************/
171 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb,
172 const sg_host_t* host_list, const double* flops_amount,
173 const double* bytes_amount, double rate, double timeout);
175 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
176 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
178 /**************************** Process simcalls ********************************/
180 XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC
181 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
183 void simcall_process_set_data(smx_actor_t process, void* data);
184 /* Process handling */
185 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
186 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
189 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
192 /************************** Comunication simcalls *****************************/
195 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
196 size_t src_buff_size,
197 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
198 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
200 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
201 void* src_buff, size_t src_buff_size,
202 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
203 void (*clean_fun)(void*),
204 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
207 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
208 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
209 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout,
212 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
213 size_t* dst_buff_size,
214 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
215 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
218 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
219 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
223 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
224 XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout);
225 XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout);
226 XBT_PUBLIC int simcall_comm_test(smx_activity_t comm);
227 XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count);
229 /************************** Synchro simcalls **********************************/
231 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
232 XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex);
233 XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex);
234 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
235 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
236 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
238 XBT_PUBLIC smx_cond_t simcall_cond_init();
239 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
240 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
242 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
243 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
245 /***************************** Io **************************************/
246 XBT_PUBLIC e_smx_state_t simcall_io_wait(smx_activity_t io);
247 /************************** MC simcalls **********************************/
248 XBT_PUBLIC int simcall_mc_random(int min, int max);
250 /***************************** DEPRECATED CALLS ****************************/
251 XBT_ATTRIB_DEPRECATED_v325("Please use sg_actor_set_kill_time()") XBT_PUBLIC
252 void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
254 XBT_ATTRIB_DEPRECATED_v325("Please use Comm::cancel()") XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
256 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::cancel()") XBT_PUBLIC
257 void simcall_execution_cancel(smx_activity_t execution);
258 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_priority()") XBT_PUBLIC
259 void simcall_execution_set_priority(smx_activity_t execution, double priority);
260 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_bound()") XBT_PUBLIC
261 void simcall_execution_set_bound(smx_activity_t execution, double bound);
265 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::start()") XBT_PUBLIC smx_activity_t
266 simcall_execution_start(const std::string& name, const std::string& category, double flops_amount, double priority,
267 double bound, sg_host_t host);