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>
33 * @ingroup simix_host_management
34 * @brief Waits for the completion of an execution synchro and destroy it.
36 * @param execution The execution synchro
38 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
39 double timeout) // XBT_ATTRIB_DEPRECATED_v330
41 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
42 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
43 return simgrid::kernel::activity::State::DONE;
46 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
47 double timeout) // XBT_ATTRIB_DEPRECATED_v330
49 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
50 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
51 return simgrid::kernel::activity::State::DONE;
54 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
56 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
59 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
61 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
64 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
65 double timeout) // XBT_ATTRIB_DEPRECATED_v331
67 std::vector<simgrid::kernel::activity::ExecImpl*> execs_vec(execs, execs + count);
68 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
69 simgrid::kernel::actor::ExecutionWaitanySimcall observer{issuer, execs_vec, timeout};
70 return simgrid::kernel::actor::simcall_blocking(
72 simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
73 observer.get_timeout());
78 simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
80 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
81 return simgrid::kernel::activity::State::DONE;
85 * @ingroup simix_comm_management
87 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
88 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
89 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
92 /* checking for infinite values */
93 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
94 xbt_assert(std::isfinite(rate), "rate is not finite!");
95 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
97 xbt_assert(mbox, "No rendez-vous point defined for send");
99 if (MC_is_active() || MC_record_replay_is_active()) {
100 /* the model-checker wants two separate simcalls */
101 simgrid::kernel::activity::ActivityImplPtr comm =
102 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
103 comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
105 simcall_comm_wait(comm.get(), timeout);
109 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
110 match_fun, copy_data_fun, data, timeout);
115 * @ingroup simix_comm_management
117 simgrid::kernel::activity::ActivityImplPtr
118 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
119 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
120 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
121 void* data, bool detached)
123 /* checking for infinite values */
124 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
125 xbt_assert(std::isfinite(rate), "rate is not finite!");
127 xbt_assert(mbox, "No rendez-vous point defined for isend");
129 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
130 match_fun, clean_fun, copy_data_fun, data, detached);
134 * @ingroup simix_comm_management
136 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
137 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
138 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
139 double timeout, double rate)
141 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
142 xbt_assert(mbox, "No rendez-vous point defined for recv");
144 if (MC_is_active() || MC_record_replay_is_active()) {
145 /* the model-checker wants two separate simcalls */
146 simgrid::kernel::activity::ActivityImplPtr comm =
147 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
148 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
149 match_fun, copy_data_fun, data, rate);
150 simcall_comm_wait(comm.get(), timeout);
154 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
155 copy_data_fun, data, timeout, rate);
159 * @ingroup simix_comm_management
161 simgrid::kernel::activity::ActivityImplPtr
162 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
163 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
164 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
166 xbt_assert(mbox, "No rendez-vous point defined for irecv");
168 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
169 copy_data_fun, data, rate);
173 * @ingroup simix_comm_management
175 simgrid::kernel::activity::ActivityImplPtr
176 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
177 void* data) // XBT_ATTRIB_DEPRECATED_v330
179 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
181 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
185 * @ingroup simix_comm_management
187 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
188 double timeout) // XBT_ATTRIB_DEPRECATED_v330
190 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
191 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
192 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
194 return simcall_BODY_comm_waitany(rcomms.data(), rcomms.size(), timeout);
197 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
199 return simcall_BODY_comm_waitany(comms, count, timeout);
203 * @ingroup simix_comm_management
205 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
209 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
210 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
211 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
213 return simcall_BODY_comm_testany(rcomms.data(), rcomms.size());
216 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
220 return simcall_BODY_comm_testany(comms, count);
224 * @ingroup simix_comm_management
226 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
228 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
229 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
233 * @ingroup simix_comm_management
236 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
238 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
242 * @ingroup simix_synchro_management
245 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
247 if (simix_global == nullptr) {
248 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
249 // get there before the initialization
252 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
256 * @ingroup simix_synchro_management
259 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
261 mutex->mutex().lock();
265 * @ingroup simix_synchro_management
268 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
270 return mutex->mutex().try_lock();
274 * @ingroup simix_synchro_management
277 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
279 mutex->mutex().unlock();
283 * @ingroup simix_synchro_management
286 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
288 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
292 * @ingroup simix_synchro_management
295 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
297 cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
301 * @ingroup simix_synchro_management
304 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
306 return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
307 std::cv_status::timeout;
311 * @ingroup simix_synchro_management
314 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
316 return sem->sem().acquire();
320 * @ingroup simix_synchro_management
323 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
325 return sem->sem().acquire_timeout(timeout);
328 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
329 double timeout) // XBT_ATTRIB_DEPRECATED_v330
331 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
332 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
333 return simgrid::kernel::activity::State::DONE;
336 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
337 double timeout) // XBT_ATTRIB_DEPRECATED_v330
339 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
340 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
341 return simgrid::kernel::activity::State::DONE;
344 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
346 return simgrid::kernel::actor::simcall([io] { return io->test(); });
349 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
351 return simgrid::kernel::actor::simcall([io] { return io->test(); });
354 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
356 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
357 simcall_BODY_run_kernel(&code);
358 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
361 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
363 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
364 simcall_BODY_run_blocking(&code);
365 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
368 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
370 return MC_random(min, max);
373 /* ************************************************************************** */
375 /** @brief returns a printable string representing a simcall */
376 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
378 if (simcall.observer_ != nullptr) {
379 static std::string name;
380 name = boost::core::demangle(typeid(*simcall.observer_).name());
381 const char* cname = name.c_str();
382 if (name.rfind("simgrid::kernel::", 0) == 0)
383 cname += 17; // strip prefix "simgrid::kernel::"
386 return simcall_names[static_cast<int>(simcall.call_)];
393 void unblock(smx_actor_t actor)
395 xbt_assert(SIMIX_is_maestro());
396 actor->simcall_answer();
399 } // namespace simgrid