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>
17 /* ******************************** Host ************************************ */
18 /** @brief Host datatype
19 @ingroup simix_host_management
21 A <em>location</em> (or <em>host</em>) is any possible place where
22 a process may run. Thus it is represented as a <em>physical
23 resource with computing capabilities</em>, some <em>mailboxes</em>
24 to enable running process to communicate with remote ones, and
25 some <em>private data</em> that can be only accessed by local
28 \see m_host_management
37 SIMIX_SRC_HOST_FAILURE,
38 SIMIX_DST_HOST_FAILURE,
46 /* ******************************** Synchro ************************************ */
49 * \ingroup simix_synchro_management
51 typedef struct s_smx_cond_t* smx_cond_t;
53 * \ingroup simix_synchro_management
55 typedef struct s_smx_sem_t* smx_sem_t;
57 /* ****************************** Process *********************************** */
62 } smx_process_exit_status_t;
65 /******************************* Networking ***********************************/
67 /* Process creation/destruction callbacks */
68 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
70 extern unsigned smx_context_stack_size;
71 extern int smx_context_stack_size_was_set;
72 extern unsigned smx_context_guard_size;
73 extern int smx_context_guard_size_was_set;
77 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
80 XBT_PUBLIC int SIMIX_context_is_parallel();
81 XBT_PUBLIC int SIMIX_context_get_nthreads();
82 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
83 XBT_PUBLIC int SIMIX_context_get_parallel_threshold();
84 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
85 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
86 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
87 XBT_PUBLIC int SIMIX_is_maestro();
89 /********************************** Global ************************************/
90 /* Initialization and exit */
91 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
93 /* Set to execute in the maestro
95 * If no maestro code is registered (the default), the main thread
96 * is assumed to be the maestro. */
97 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
99 XBT_PUBLIC void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
100 XBT_PUBLIC void SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
102 /* Simulation execution */
103 XBT_PUBLIC void SIMIX_run();
104 XBT_PUBLIC double SIMIX_get_clock();
106 /* Timer functions FIXME: should these be public? */
107 typedef struct s_smx_timer_t* smx_timer_t;
109 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
110 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
111 XBT_PUBLIC double SIMIX_timer_next();
112 XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer);
114 XBT_PUBLIC void SIMIX_display_process_status();
116 /******************************* Environment **********************************/
117 XBT_PUBLIC void SIMIX_create_environment(const char* file);
119 /******************************** Deployment **********************************/
121 XBT_PUBLIC void SIMIX_function_register(const char* name, xbt_main_func_t code);
122 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
123 XBT_PUBLIC void SIMIX_init_application();
124 XBT_PUBLIC void SIMIX_launch_application(const char* file);
126 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
127 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
129 /*********************************** Host *************************************/
130 /* Functions for running a process in main()
132 * 1. create the maestro process
133 * 2. attach (create a context and wait for maestro to give control back to you)
134 * 3. do you process job
135 * 4. detach (this waits for the simulation to terminate)
138 XBT_PUBLIC void SIMIX_maestro_create(void (*code)(void*), void* data);
140 XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
141 std::map<std::string, std::string>* properties, smx_actor_t parent_process);
143 XBT_PUBLIC void SIMIX_process_detach();
145 /*********************************** Host *************************************/
146 XBT_PUBLIC void SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
148 /********************************* Process ************************************/
149 XBT_PUBLIC int SIMIX_process_count();
150 XBT_PUBLIC smx_actor_t SIMIX_process_self();
151 XBT_PUBLIC const char* SIMIX_process_self_get_name();
152 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
153 XBT_PUBLIC void* SIMIX_process_self_get_data();
154 XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process);
155 XBT_PUBLIC void SIMIX_process_on_exit_runall(smx_actor_t process);
156 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
160 /****************************** Communication *********************************/
161 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t));
162 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
163 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
165 XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
167 /******************************************************************************/
169 /******************************************************************************/
170 /* These functions are a system call-like interface to the simulation kernel. */
171 /* They can also be called from maestro's context, and they are thread safe. */
172 /******************************************************************************/
174 XBT_PUBLIC void simcall_call(smx_actor_t process);
176 /******************************* Host simcalls ********************************/
177 XBT_PUBLIC smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound,
179 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
180 double* flops_amount, double* bytes_amount, double rate,
182 XBT_PUBLIC void simcall_execution_cancel(smx_activity_t execution);
183 XBT_PUBLIC void simcall_execution_set_priority(smx_activity_t execution, double priority);
184 XBT_PUBLIC void simcall_execution_set_bound(smx_activity_t execution, double bound);
185 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
186 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
188 /**************************** Process simcalls ********************************/
190 /* Constructor and Destructor */
192 XBT_PUBLIC smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host,
193 int argc, char** argv, std::map<std::string, std::string>* properties);
196 XBT_PUBLIC void simcall_process_killall();
197 XBT_PUBLIC void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
199 /* Process handling */
200 XBT_PUBLIC void simcall_process_cleanup(smx_actor_t process);
201 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
203 /* Getters and Setters */
204 XBT_PUBLIC int simcall_process_count();
205 XBT_PUBLIC void simcall_process_set_data(smx_actor_t process, void* data);
206 XBT_PUBLIC void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
207 XBT_PUBLIC void simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
208 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
210 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
213 /************************** Comunication simcalls *****************************/
216 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
217 size_t src_buff_size,
218 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
219 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
221 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
222 void* src_buff, size_t src_buff_size,
223 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
224 void (*clean_fun)(void*),
225 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
228 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
229 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
230 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout,
233 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
234 size_t* dst_buff_size,
235 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
236 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
239 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
240 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
243 XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
245 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
246 XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout);
247 XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout);
248 XBT_PUBLIC int simcall_comm_test(smx_activity_t comm);
249 XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count);
251 /************************** Tracing handling **********************************/
252 XBT_PUBLIC void simcall_set_category(smx_activity_t synchro, const char* category);
254 /************************** Synchro simcalls **********************************/
256 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
257 XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex);
258 XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex);
259 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
260 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
261 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
263 XBT_PUBLIC smx_cond_t simcall_cond_init();
264 XBT_PUBLIC void SIMIX_cond_unref(smx_cond_t cond);
265 XBT_PUBLIC smx_cond_t SIMIX_cond_ref(smx_cond_t cond);
266 XBT_PUBLIC void simcall_cond_signal(smx_cond_t cond);
267 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
268 XBT_PUBLIC void simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
269 XBT_PUBLIC void simcall_cond_broadcast(smx_cond_t cond);
271 XBT_PUBLIC void SIMIX_sem_destroy(smx_sem_t sem);
272 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
273 XBT_PUBLIC void simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
275 /***************************** Storage **********************************/
276 XBT_PUBLIC sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size);
277 XBT_PUBLIC sg_size_t simcall_storage_write(surf_storage_t fd, sg_size_t size);
278 /************************** MC simcalls **********************************/
279 XBT_PUBLIC int simcall_mc_random(int min, int max);