1 /* libsmx.c - public interface to simix */
3 /* These functions are the only ones that are visible from the higher levels */
4 /* (most of them simply add some documentation to the generated simcall body) */
6 /* This is somehow the "libc" of SimGrid */
8 /* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved. */
10 /* This program is free software; you can redistribute it and/or modify it
11 * under the terms of the license (GNU LGPL) which comes with this package. */
14 #include "simgrid/simix/blocking_simcall.hpp"
15 #include "src/kernel/activity/CommImpl.hpp"
16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
17 #include "src/kernel/activity/ExecImpl.hpp"
18 #include "src/kernel/activity/IoImpl.hpp"
19 #include "src/kernel/activity/MutexImpl.hpp"
20 #include "src/mc/mc_replay.hpp"
21 #include "src/plugins/vm/VirtualMachineImpl.hpp"
22 #include "src/simix/smx_host_private.hpp"
23 #include "src/simix/smx_io_private.hpp"
25 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
27 #include "popping_bodies.cpp"
30 * @ingroup simix_process_management
31 * @brief Creates a synchro that may involve parallel computation on
32 * several hosts and communication between them.
34 * @param name Name of the execution synchro to create
35 * @param host_nb Number of hosts where the synchro will be executed
36 * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
37 * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
38 * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
39 * amount between each pair of hosts
40 * @param rate the SURF action rate
41 * @param timeout timeout
42 * @return A new SIMIX execution synchronization
44 smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list,
45 double* flops_amount, double* bytes_amount, double rate, double timeout)
47 /* checking for infinite values */
48 for (int i = 0 ; i < host_nb ; ++i) {
49 if (flops_amount != nullptr)
50 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
51 if (bytes_amount != nullptr) {
52 for (int j = 0 ; j < host_nb ; ++j) {
53 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
54 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
59 xbt_assert(std::isfinite(rate), "rate is not finite!");
61 return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
62 return SIMIX_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
67 * @ingroup simix_host_management
68 * @brief Waits for the completion of an execution synchro and destroy it.
70 * @param execution The execution synchro
72 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
74 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
77 e_smx_state_t simcall_execution_test(smx_activity_t execution)
79 return (e_smx_state_t)simcall_BODY_execution_test(execution);
82 void simcall_process_join(smx_actor_t process, double timeout)
84 simcall_BODY_process_join(process, timeout);
88 * @ingroup simix_process_management
89 * @brief Suspends an actor
91 void simcall_process_suspend(smx_actor_t process)
93 simcall_BODY_process_suspend(process);
97 * @ingroup simix_process_management
98 * @brief Set the user data of a #smx_actor_t.
100 * This functions sets the user data associated to @a process.
101 * @param process SIMIX process
102 * @param data User data
104 void simcall_process_set_data(smx_actor_t process, void *data)
106 simgrid::simix::simcall([process, data] { process->set_user_data(data); });
110 * @ingroup simix_process_management
111 * @brief Set the kill time of a process.
113 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
116 if (kill_time <= SIMIX_get_clock())
118 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->get_cname(), process->host_->get_cname());
119 process->kill_timer = SIMIX_timer_set(kill_time, [process] {
120 SIMIX_process_kill(process, nullptr);
121 process->kill_timer=nullptr;
126 * @ingroup simix_process_management
127 * @brief Creates a new sleep SIMIX synchro.
129 * This function creates a SURF action and allocates the data necessary
130 * to create the SIMIX synchro. It can raise a HostFailureException if the
131 * host crashed. The default SIMIX name of the synchro is "sleep".
133 * @param duration Time duration of the sleep.
134 * @return A result telling whether the sleep was successful
136 e_smx_state_t simcall_process_sleep(double duration)
138 /* checking for infinite values */
139 xbt_assert(std::isfinite(duration), "duration is not finite!");
140 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
144 * @ingroup simix_comm_management
146 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
147 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
148 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
150 /* checking for infinite values */
151 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
152 xbt_assert(std::isfinite(rate), "rate is not finite!");
153 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
155 xbt_assert(mbox, "No rendez-vous point defined for send");
157 if (MC_is_active() || MC_record_replay_is_active()) {
158 /* the model-checker wants two separate simcalls */
159 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
160 comm = simcall_comm_isend(sender, mbox, task_size, rate,
161 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
162 simcall_comm_wait(comm, timeout);
166 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
167 match_fun, copy_data_fun, data, timeout);
172 * @ingroup simix_comm_management
174 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
175 size_t src_buff_size,
176 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
177 void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
178 void* data, int detached)
180 /* checking for infinite values */
181 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
182 xbt_assert(std::isfinite(rate), "rate is not finite!");
184 xbt_assert(mbox, "No rendez-vous point defined for isend");
186 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
187 src_buff_size, match_fun,
188 clean_fun, copy_data_fun, data, detached);
192 * @ingroup simix_comm_management
194 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
195 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
196 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
198 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
199 xbt_assert(mbox, "No rendez-vous point defined for recv");
201 if (MC_is_active() || MC_record_replay_is_active()) {
202 /* the model-checker wants two separate simcalls */
203 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
204 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
205 match_fun, copy_data_fun, data, rate);
206 simcall_comm_wait(comm, timeout);
210 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
211 match_fun, copy_data_fun, data, timeout, rate);
215 * @ingroup simix_comm_management
217 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_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 rate)
221 xbt_assert(mbox, "No rendez-vous point defined for irecv");
223 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
224 match_fun, copy_data_fun, data, rate);
228 * @ingroup simix_comm_management
230 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
231 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
233 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
235 return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
239 * @ingroup simix_comm_management
241 void simcall_comm_cancel(smx_activity_t synchro)
243 simgrid::simix::simcall([synchro] {
244 simgrid::kernel::activity::CommImplPtr comm =
245 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
251 * @ingroup simix_comm_management
253 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
255 return simcall_BODY_comm_waitany(comms, timeout);
259 * @ingroup simix_comm_management
261 int simcall_comm_testany(smx_activity_t* comms, size_t count)
265 return simcall_BODY_comm_testany(comms, count);
269 * @ingroup simix_comm_management
271 void simcall_comm_wait(smx_activity_t comm, double timeout)
273 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
274 simcall_BODY_comm_wait(comm, timeout);
278 * @ingroup simix_comm_management
281 int simcall_comm_test(smx_activity_t comm)
283 return simcall_BODY_comm_test(comm);
287 * @ingroup simix_synchro_management
290 smx_mutex_t simcall_mutex_init()
292 if (simix_global == nullptr) {
293 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
294 // get there before the initialization
297 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
301 * @ingroup simix_synchro_management
304 void simcall_mutex_lock(smx_mutex_t mutex)
306 simcall_BODY_mutex_lock(mutex);
310 * @ingroup simix_synchro_management
313 int simcall_mutex_trylock(smx_mutex_t mutex)
315 return simcall_BODY_mutex_trylock(mutex);
319 * @ingroup simix_synchro_management
322 void simcall_mutex_unlock(smx_mutex_t mutex)
324 simcall_BODY_mutex_unlock(mutex);
328 * @ingroup simix_synchro_management
331 smx_cond_t simcall_cond_init()
333 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
337 * @ingroup simix_synchro_management
340 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
342 simcall_BODY_cond_wait(cond, mutex);
346 * @ingroup simix_synchro_management
349 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
351 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
352 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
356 * @ingroup simix_synchro_management
359 void simcall_sem_acquire(smx_sem_t sem)
361 simcall_BODY_sem_acquire(sem);
365 * @ingroup simix_synchro_management
368 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
370 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
371 return simcall_BODY_sem_acquire_timeout(sem, timeout);
374 e_smx_state_t simcall_io_wait(smx_activity_t io)
376 return (e_smx_state_t)simcall_BODY_io_wait(io);
379 void simcall_run_kernel(std::function<void()> const& code)
381 simcall_BODY_run_kernel(&code);
384 void simcall_run_blocking(std::function<void()> const& code)
386 simcall_BODY_run_blocking(&code);
389 int simcall_mc_random(int min, int max) {
390 return simcall_BODY_mc_random(min, max);
393 /* ************************************************************************** */
395 /** @brief returns a printable string representing a simcall */
396 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
397 return simcall_names[kind];
403 void unblock(smx_actor_t process)
405 xbt_assert(SIMIX_is_maestro());
406 SIMIX_simcall_answer(&process->simcall);