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-2021. 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 "src/kernel/activity/CommImpl.hpp"
15 #include "src/kernel/activity/ConditionVariableImpl.hpp"
16 #include "src/kernel/activity/ExecImpl.hpp"
17 #include "src/kernel/activity/IoImpl.hpp"
18 #include "src/kernel/activity/MailboxImpl.hpp"
19 #include "src/kernel/activity/MutexImpl.hpp"
20 #include "src/kernel/activity/SemaphoreImpl.hpp"
21 #include "src/kernel/actor/SimcallObserver.hpp"
22 #include "src/mc/mc_replay.hpp"
23 #include "src/plugins/vm/VirtualMachineImpl.hpp"
24 #include "xbt/random.hpp"
26 #include "popping_bodies.cpp"
28 #include <boost/core/demangle.hpp>
32 * @ingroup simix_host_management
33 * @brief Waits for the completion of an execution synchro and destroy it.
35 * @param execution The execution synchro
37 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
38 double timeout) // XBT_ATTRIB_DEPRECATED_v330
40 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
41 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
42 return simgrid::kernel::activity::State::DONE;
45 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
46 double timeout) // XBT_ATTRIB_DEPRECATED_v330
48 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
49 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
50 return simgrid::kernel::activity::State::DONE;
53 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
55 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
58 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
60 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
63 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
64 double timeout) // XBT_ATTRIB_DEPRECATED_v331
66 std::vector<simgrid::kernel::activity::ExecImpl*> execs_vec(execs, execs + count);
67 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
68 simgrid::kernel::actor::ExecutionWaitanySimcall observer{issuer, execs_vec, timeout};
69 return simgrid::kernel::actor::simcall_blocking(
71 simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
72 observer.get_timeout());
77 simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
79 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
80 return simgrid::kernel::activity::State::DONE;
84 * @ingroup simix_comm_management
86 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
87 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
88 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
91 /* checking for infinite values */
92 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
93 xbt_assert(std::isfinite(rate), "rate is not finite!");
94 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
96 xbt_assert(mbox, "No rendez-vous point defined for send");
98 if (MC_is_active() || MC_record_replay_is_active()) {
99 /* the model-checker wants two separate simcalls */
100 simgrid::kernel::activity::ActivityImplPtr comm =
101 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
102 comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
104 simcall_comm_wait(comm.get(), timeout);
108 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
109 match_fun, copy_data_fun, data, timeout);
114 * @ingroup simix_comm_management
116 simgrid::kernel::activity::ActivityImplPtr
117 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
118 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
119 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
120 void* data, bool detached)
122 /* checking for infinite values */
123 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
124 xbt_assert(std::isfinite(rate), "rate is not finite!");
126 xbt_assert(mbox, "No rendez-vous point defined for isend");
128 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
129 match_fun, clean_fun, copy_data_fun, data, detached);
133 * @ingroup simix_comm_management
135 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
136 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
137 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
138 double timeout, double rate)
140 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
141 xbt_assert(mbox, "No rendez-vous point defined for recv");
143 if (MC_is_active() || MC_record_replay_is_active()) {
144 /* the model-checker wants two separate simcalls */
145 simgrid::kernel::activity::ActivityImplPtr comm =
146 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
147 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
148 match_fun, copy_data_fun, data, rate);
149 simcall_comm_wait(comm.get(), timeout);
153 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
154 copy_data_fun, data, timeout, rate);
158 * @ingroup simix_comm_management
160 simgrid::kernel::activity::ActivityImplPtr
161 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
162 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
163 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
165 xbt_assert(mbox, "No rendez-vous point defined for irecv");
167 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
168 copy_data_fun, data, rate);
172 * @ingroup simix_comm_management
174 simgrid::kernel::activity::ActivityImplPtr
175 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
176 void* data) // XBT_ATTRIB_DEPRECATED_v330
178 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
180 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
184 * @ingroup simix_comm_management
186 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
187 double timeout) // XBT_ATTRIB_DEPRECATED_v330
189 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
190 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
191 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
193 return simcall_BODY_comm_waitany(rcomms.data(), rcomms.size(), timeout);
196 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
198 return simcall_BODY_comm_waitany(comms, count, timeout);
202 * @ingroup simix_comm_management
204 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
208 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
209 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
210 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
212 return simcall_BODY_comm_testany(rcomms.data(), rcomms.size());
215 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
219 return simcall_BODY_comm_testany(comms, count);
223 * @ingroup simix_comm_management
225 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
227 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
228 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
232 * @ingroup simix_comm_management
235 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
237 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
241 * @ingroup simix_synchro_management
244 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
246 if (simix_global == nullptr) {
247 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
248 // get there before the initialization
251 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
255 * @ingroup simix_synchro_management
258 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
260 mutex->mutex().lock();
264 * @ingroup simix_synchro_management
267 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
269 return mutex->mutex().try_lock();
273 * @ingroup simix_synchro_management
276 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
278 mutex->mutex().unlock();
282 * @ingroup simix_synchro_management
285 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
287 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
291 * @ingroup simix_synchro_management
294 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
296 cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
300 * @ingroup simix_synchro_management
303 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
305 return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
306 std::cv_status::timeout;
310 * @ingroup simix_synchro_management
313 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
315 return sem->sem().acquire();
319 * @ingroup simix_synchro_management
322 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
324 return sem->sem().acquire_timeout(timeout);
327 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
328 double timeout) // XBT_ATTRIB_DEPRECATED_v330
330 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
331 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
332 return simgrid::kernel::activity::State::DONE;
335 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
336 double timeout) // XBT_ATTRIB_DEPRECATED_v330
338 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
339 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
340 return simgrid::kernel::activity::State::DONE;
343 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
345 return simgrid::kernel::actor::simcall([io] { return io->test(); });
348 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
350 return simgrid::kernel::actor::simcall([io] { return io->test(); });
353 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
355 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
356 simcall_BODY_run_kernel(&code);
357 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
360 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
362 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
363 simcall_BODY_run_blocking(&code);
364 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
367 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
369 return MC_random(min, max);
372 /* ************************************************************************** */
374 /** @brief returns a printable string representing a simcall */
375 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
377 if (simcall.observer_ != nullptr) {
378 static std::string name;
379 name = boost::core::demangle(typeid(*simcall.observer_).name());
380 const char* cname = name.c_str();
381 if (name.rfind("simgrid::kernel::", 0) == 0)
382 cname += 17; // strip prefix "simgrid::kernel::"
385 return simcall_names[static_cast<int>(simcall.call_)];
392 void unblock(smx_actor_t actor)
394 xbt_assert(SIMIX_is_maestro());
395 actor->simcall_answer();
398 } // namespace simgrid