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-2020. 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/MailboxImpl.hpp"
20 #include "src/kernel/activity/MutexImpl.hpp"
21 #include "src/mc/mc_replay.hpp"
22 #include "src/plugins/vm/VirtualMachineImpl.hpp"
24 #include "popping_bodies.cpp"
27 * @ingroup simix_host_management
28 * @brief Waits for the completion of an execution synchro and destroy it.
30 * @param execution The execution synchro
32 e_smx_state_t simcall_execution_wait(const smx_activity_t& execution, double timeout)
34 return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()),
38 bool simcall_execution_test(const smx_activity_t& execution)
40 return simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
43 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
45 return simcall_BODY_execution_waitany_for(execs, count, timeout);
48 void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
50 simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
53 void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
55 process->iface()->suspend();
58 e_smx_state_t simcall_process_sleep(double duration) // XBT_DEPRECATED_v329
60 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
61 return simgrid::kernel::activity::State::DONE;
65 * @ingroup simix_comm_management
67 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
68 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
69 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
72 /* checking for infinite values */
73 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
74 xbt_assert(std::isfinite(rate), "rate is not finite!");
75 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
77 xbt_assert(mbox, "No rendez-vous point defined for send");
79 if (MC_is_active() || MC_record_replay_is_active()) {
80 /* the model-checker wants two separate simcalls */
81 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
82 comm = simcall_comm_isend(sender, mbox, task_size, rate,
83 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
84 simcall_comm_wait(comm, timeout);
88 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
89 match_fun, copy_data_fun, data, timeout);
94 * @ingroup simix_comm_management
96 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
98 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
99 void (*clean_fun)(void*),
100 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
101 void* data, bool detached)
103 /* checking for infinite values */
104 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
105 xbt_assert(std::isfinite(rate), "rate is not finite!");
107 xbt_assert(mbox, "No rendez-vous point defined for isend");
109 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
110 match_fun, clean_fun, copy_data_fun, data, detached);
114 * @ingroup simix_comm_management
116 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
117 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
118 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
119 double timeout, double rate)
121 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
122 xbt_assert(mbox, "No rendez-vous point defined for recv");
124 if (MC_is_active() || MC_record_replay_is_active()) {
125 /* the model-checker wants two separate simcalls */
126 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
127 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
128 match_fun, copy_data_fun, data, rate);
129 simcall_comm_wait(comm, timeout);
133 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
134 copy_data_fun, data, timeout, rate);
138 * @ingroup simix_comm_management
140 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
141 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
142 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
143 void* data, double rate)
145 xbt_assert(mbox, "No rendez-vous point defined for irecv");
147 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
148 copy_data_fun, data, rate);
152 * @ingroup simix_comm_management
154 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
155 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
157 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
159 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
163 * @ingroup simix_comm_management
165 unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout)
167 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
168 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
169 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
171 return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
174 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
176 return simcall_BODY_comm_waitany(comms, count, timeout);
180 * @ingroup simix_comm_management
182 int simcall_comm_testany(smx_activity_t comms[], size_t count)
186 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
187 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
188 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
190 return simcall_BODY_comm_testany(rcomms.get(), count);
193 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
197 return simcall_BODY_comm_testany(comms, count);
201 * @ingroup simix_comm_management
203 void simcall_comm_wait(const smx_activity_t& comm, double timeout)
205 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
206 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
210 * @ingroup simix_comm_management
213 bool simcall_comm_test(const smx_activity_t& comm)
215 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
219 * @ingroup simix_synchro_management
222 smx_mutex_t simcall_mutex_init()
224 if (simix_global == nullptr) {
225 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
226 // get there before the initialization
229 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
233 * @ingroup simix_synchro_management
236 void simcall_mutex_lock(smx_mutex_t mutex)
238 simcall_BODY_mutex_lock(mutex);
242 * @ingroup simix_synchro_management
245 int simcall_mutex_trylock(smx_mutex_t mutex)
247 return simcall_BODY_mutex_trylock(mutex);
251 * @ingroup simix_synchro_management
254 void simcall_mutex_unlock(smx_mutex_t mutex)
256 simcall_BODY_mutex_unlock(mutex);
260 * @ingroup simix_synchro_management
263 smx_cond_t simcall_cond_init()
265 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
269 * @ingroup simix_synchro_management
272 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
274 simcall_BODY_cond_wait(cond, mutex);
278 * @ingroup simix_synchro_management
281 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
283 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
284 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
288 * @ingroup simix_synchro_management
291 void simcall_sem_acquire(smx_sem_t sem)
293 simcall_BODY_sem_acquire(sem);
297 * @ingroup simix_synchro_management
300 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
302 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
303 return simcall_BODY_sem_acquire_timeout(sem, timeout);
306 e_smx_state_t simcall_io_wait(const smx_activity_t& io, double timeout)
308 return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()), timeout);
311 bool simcall_io_test(const smx_activity_t& io)
313 return simcall_BODY_io_test(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
316 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
318 simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
319 simcall_BODY_run_kernel(&code);
322 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
324 simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
325 simcall_BODY_run_blocking(&code);
328 int simcall_mc_random(int min, int max) {
329 return simcall_BODY_mc_random(min, max);
332 /* ************************************************************************** */
334 /** @brief returns a printable string representing a simcall */
335 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
336 return simcall_names[kind];
342 void unblock(smx_actor_t actor)
344 xbt_assert(SIMIX_is_maestro());
345 actor->simcall_answer();
348 } // namespace simgrid