1 /* Copyright (c) 2007-2018. 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 /* ******************************** Synchro ************************************ */
51 /** @ingroup simix_synchro_management */
52 typedef struct s_smx_sem_t* smx_sem_t;
54 /* ****************************** Process *********************************** */
59 } smx_process_exit_status_t;
62 /******************************* Networking ***********************************/
64 /* Process creation/destruction callbacks */
65 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
67 extern unsigned smx_context_stack_size;
68 extern int smx_context_stack_size_was_set;
69 extern unsigned smx_context_guard_size;
70 extern int smx_context_guard_size_was_set;
74 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
77 XBT_PUBLIC int SIMIX_context_is_parallel();
78 XBT_PUBLIC int SIMIX_context_get_nthreads();
79 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
80 XBT_PUBLIC int SIMIX_context_get_parallel_threshold();
81 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
82 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
83 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
84 XBT_PUBLIC int SIMIX_is_maestro();
86 /********************************** Global ************************************/
87 /* Initialization and exit */
88 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
90 /* Set to execute in the maestro
92 * If no maestro code is registered (the default), the main thread
93 * is assumed to be the maestro. */
94 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
96 /* Simulation execution */
97 XBT_PUBLIC void SIMIX_run();
98 XBT_PUBLIC double SIMIX_get_clock();
100 /* Timer functions FIXME: should these be public? */
101 typedef struct s_smx_timer_t* smx_timer_t;
103 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
104 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
105 XBT_PUBLIC double SIMIX_timer_next();
106 XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer);
108 XBT_PUBLIC void SIMIX_display_process_status();
111 /******************************* Environment **********************************/
113 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC
114 void SIMIX_create_environment(const char* file);
118 XBT_PUBLIC void SIMIX_create_environment(std::string file);
121 /******************************** Deployment **********************************/
123 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC
124 void SIMIX_function_register(const char* name, xbt_main_func_t code);
125 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC
126 void SIMIX_launch_application(const char* file);
127 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
129 XBT_PUBLIC void SIMIX_init_application();
130 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
131 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
135 XBT_PUBLIC void SIMIX_function_register(std::string name, void (*code)(std::vector<std::string>));
136 XBT_PUBLIC void SIMIX_function_register(std::string name, xbt_main_func_t code);
137 XBT_PUBLIC void SIMIX_launch_application(std::string file);
140 /*********************************** Host *************************************/
141 /* Functions for running a process in main()
143 * 1. create the maestro process
144 * 2. attach (create a context and wait for maestro to give control back to you)
145 * 3. do you process job
146 * 4. detach (this waits for the simulation to terminate)
150 XBT_PUBLIC void SIMIX_maestro_create(void (*code)(void*), void* data);
153 XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
154 std::unordered_map<std::string, std::string>* properties,
155 smx_actor_t parent_process);
158 XBT_PUBLIC void SIMIX_process_detach();
161 /********************************* Process ************************************/
163 XBT_PUBLIC int SIMIX_process_count();
164 XBT_PUBLIC smx_actor_t SIMIX_process_self();
165 XBT_PUBLIC const char* SIMIX_process_self_get_name();
166 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
167 XBT_PUBLIC void* SIMIX_process_self_get_data();
168 XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process);
169 XBT_PUBLIC void SIMIX_process_on_exit_runall(smx_actor_t process);
170 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
174 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data);
177 /****************************** Communication *********************************/
178 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t));
179 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
180 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
182 XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
184 /******************************************************************************/
186 /******************************************************************************/
187 /* These functions are a system call-like interface to the simulation kernel. */
188 /* They can also be called from maestro's context, and they are thread safe. */
189 /******************************************************************************/
191 /******************************* Host simcalls ********************************/
193 XBT_PUBLIC smx_activity_t simcall_execution_start(std::string name, std::string category, double flops_amount,
194 double priority, double bound, sg_host_t host);
195 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list,
196 double* flops_amount, double* bytes_amount, double rate,
199 XBT_PUBLIC void simcall_execution_cancel(smx_activity_t execution);
200 XBT_PUBLIC void simcall_execution_set_priority(smx_activity_t execution, double priority);
201 XBT_PUBLIC void simcall_execution_set_bound(smx_activity_t execution, double bound);
202 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
203 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
205 /**************************** Process simcalls ********************************/
207 /* Constructor and Destructor */
209 XBT_PUBLIC smx_actor_t simcall_process_create(std::string name, xbt_main_func_t code, void* data, sg_host_t host,
210 int argc, char** argv,
211 std::unordered_map<std::string, std::string>* properties);
214 XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC
215 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
217 /* Process handling */
218 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
220 /* Getters and Setters */
221 XBT_PUBLIC void simcall_process_set_data(smx_actor_t process, void* data);
222 XBT_PUBLIC void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
223 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
225 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
228 /************************** Comunication simcalls *****************************/
231 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
232 size_t src_buff_size,
233 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
234 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
236 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
237 void* src_buff, size_t src_buff_size,
238 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
239 void (*clean_fun)(void*),
240 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
243 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
244 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
245 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout,
248 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
249 size_t* dst_buff_size,
250 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
251 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
254 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
255 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
258 XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
260 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
261 XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout);
262 XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout);
263 XBT_PUBLIC int simcall_comm_test(smx_activity_t comm);
264 XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count);
266 /************************** Tracing handling **********************************/
268 XBT_PUBLIC void simcall_set_category(smx_activity_t synchro, std::string category);
271 /************************** Synchro simcalls **********************************/
273 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
274 XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex);
275 XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex);
276 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
277 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
278 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
280 XBT_PUBLIC smx_cond_t simcall_cond_init();
281 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
282 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
284 XBT_PUBLIC void SIMIX_sem_destroy(smx_sem_t sem);
285 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
286 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
288 /***************************** Io **************************************/
289 XBT_PUBLIC e_smx_state_t simcall_io_wait(smx_activity_t io);
290 /************************** MC simcalls **********************************/
291 XBT_PUBLIC int simcall_mc_random(int min, int max);