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 /******************************** Deployment **********************************/
99 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
101 XBT_PUBLIC void SIMIX_init_application();
102 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
103 xbt_dynar_t arguments, double process_start_time, double process_kill_time);
107 XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
108 XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
109 XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
112 /********************************* Process ************************************/
114 XBT_PUBLIC int SIMIX_process_count();
115 XBT_PUBLIC smx_actor_t SIMIX_process_self();
116 XBT_PUBLIC const char* SIMIX_process_self_get_name();
117 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
118 XBT_PUBLIC void* SIMIX_process_self_get_data();
122 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
125 /****************************** Communication *********************************/
127 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
129 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
131 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
135 /******************************************************************************/
137 /******************************************************************************/
138 /* These functions are a system call-like interface to the simulation kernel. */
139 /* They can also be called from maestro's context, and they are thread safe. */
140 /******************************************************************************/
142 /******************************* Host simcalls ********************************/
144 XBT_PUBLIC e_smx_state_t simcall_execution_wait(const smx_activity_t& execution);
145 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
147 XBT_PUBLIC bool simcall_execution_test(const smx_activity_t& execution);
150 /**************************** Process simcalls ********************************/
152 void simcall_process_set_data(smx_actor_t process, void* data);
153 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::suspend()") XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
155 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::join()") XBT_PUBLIC
156 void simcall_process_join(smx_actor_t process, double timeout);
159 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
162 /************************** Comunication simcalls *****************************/
165 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
166 size_t src_buff_size,
167 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
168 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
169 void* data, double timeout);
171 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
172 void* src_buff, size_t src_buff_size,
173 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
174 void (*clean_fun)(void*),
175 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
176 void* data, bool detached);
178 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
179 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
180 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
181 void* data, double timeout, double rate);
183 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
184 size_t* dst_buff_size,
185 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
186 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
187 void* data, double rate);
189 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
190 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
193 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
194 XBT_PUBLIC unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout);
195 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
197 XBT_PUBLIC void simcall_comm_wait(const smx_activity_t& comm, double timeout);
198 XBT_PUBLIC bool simcall_comm_test(const smx_activity_t& comm);
199 XBT_PUBLIC int simcall_comm_testany(smx_activity_t comms[], size_t count);
200 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
203 /************************** Synchro simcalls **********************************/
205 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
206 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
207 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
208 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
210 XBT_PUBLIC smx_cond_t simcall_cond_init();
211 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
212 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
214 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
215 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
218 /***************************** Io **************************************/
220 XBT_PUBLIC e_smx_state_t simcall_io_wait(const smx_activity_t& io);
222 /************************** MC simcalls **********************************/
224 XBT_PUBLIC int simcall_mc_random(int min, int max);