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"
29 * @ingroup simix_host_management
30 * @brief Waits for the completion of an execution synchro and destroy it.
32 * @param execution The execution synchro
34 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
35 double timeout) // XBT_ATTRIB_DEPRECATED_v330
37 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
38 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
39 return simgrid::kernel::activity::State::DONE;
42 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
43 double timeout) // XBT_ATTRIB_DEPRECATED_v330
45 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
46 simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
47 return simgrid::kernel::activity::State::DONE;
50 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
52 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
55 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
57 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
60 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
61 double timeout) // XBT_ATTRIB_DEPRECATED_v331
63 std::vector<simgrid::kernel::activity::ExecImpl*> execsv(execs, execs + count);
64 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
65 simgrid::kernel::actor::ExecutionWaitanySimcall observer{issuer, &execsv, timeout};
66 return simgrid::kernel::actor::simcall_blocking(
68 simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
69 observer.get_timeout());
74 simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
76 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
77 return simgrid::kernel::activity::State::DONE;
81 * @ingroup simix_comm_management
83 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
84 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
85 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
88 /* checking for infinite values */
89 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
90 xbt_assert(std::isfinite(rate), "rate is not finite!");
91 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
93 xbt_assert(mbox, "No rendez-vous point defined for send");
95 if (MC_is_active() || MC_record_replay_is_active()) {
96 /* the model-checker wants two separate simcalls */
97 simgrid::kernel::activity::ActivityImplPtr comm =
98 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
99 comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
101 simcall_comm_wait(comm.get(), timeout);
105 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
106 match_fun, copy_data_fun, data, timeout);
111 * @ingroup simix_comm_management
113 simgrid::kernel::activity::ActivityImplPtr
114 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
115 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
116 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
117 void* data, bool detached)
119 /* checking for infinite values */
120 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
121 xbt_assert(std::isfinite(rate), "rate is not finite!");
123 xbt_assert(mbox, "No rendez-vous point defined for isend");
125 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
126 match_fun, clean_fun, copy_data_fun, data, detached);
130 * @ingroup simix_comm_management
132 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
133 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
134 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
135 double timeout, double rate)
137 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
138 xbt_assert(mbox, "No rendez-vous point defined for recv");
140 if (MC_is_active() || MC_record_replay_is_active()) {
141 /* the model-checker wants two separate simcalls */
142 simgrid::kernel::activity::ActivityImplPtr comm =
143 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
144 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
145 match_fun, copy_data_fun, data, rate);
146 simcall_comm_wait(comm.get(), timeout);
150 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
151 copy_data_fun, data, timeout, rate);
155 * @ingroup simix_comm_management
157 simgrid::kernel::activity::ActivityImplPtr
158 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
159 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
160 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
162 xbt_assert(mbox, "No rendez-vous point defined for irecv");
164 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
165 copy_data_fun, data, rate);
169 * @ingroup simix_comm_management
171 simgrid::kernel::activity::ActivityImplPtr
172 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
173 void* data) // XBT_ATTRIB_DEPRECATED_v330
175 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
177 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
181 * @ingroup simix_comm_management
183 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
184 double timeout) // XBT_ATTRIB_DEPRECATED_v330
186 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
187 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
188 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
190 return simcall_BODY_comm_waitany(rcomms.data(), rcomms.size(), timeout);
193 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
195 return simcall_BODY_comm_waitany(comms, count, timeout);
199 * @ingroup simix_comm_management
201 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
205 std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
206 std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
207 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
209 return simcall_BODY_comm_testany(rcomms.data(), rcomms.size());
212 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
216 return simcall_BODY_comm_testany(comms, count);
220 * @ingroup simix_comm_management
222 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
224 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
225 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
229 * @ingroup simix_comm_management
232 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
234 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
238 * @ingroup simix_synchro_management
241 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
243 if (simix_global == nullptr) {
244 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
245 // get there before the initialization
248 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
252 * @ingroup simix_synchro_management
255 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
257 mutex->mutex().lock();
261 * @ingroup simix_synchro_management
264 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
266 return mutex->mutex().try_lock();
270 * @ingroup simix_synchro_management
273 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
275 mutex->mutex().unlock();
279 * @ingroup simix_synchro_management
282 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
284 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
288 * @ingroup simix_synchro_management
291 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
293 cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
297 * @ingroup simix_synchro_management
300 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
302 return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
303 std::cv_status::timeout;
307 * @ingroup simix_synchro_management
310 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
312 return sem->sem().acquire();
316 * @ingroup simix_synchro_management
319 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
321 return sem->sem().acquire_timeout(timeout);
324 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
325 double timeout) // XBT_ATTRIB_DEPRECATED_v330
327 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
328 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
329 return simgrid::kernel::activity::State::DONE;
332 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
333 double timeout) // XBT_ATTRIB_DEPRECATED_v330
335 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
336 simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
337 return simgrid::kernel::activity::State::DONE;
340 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
342 return simgrid::kernel::actor::simcall([io] { return io->test(); });
345 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
347 return simgrid::kernel::actor::simcall([io] { return io->test(); });
350 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
352 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
353 simcall_BODY_run_kernel(&code);
354 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
357 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
359 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
360 simcall_BODY_run_blocking(&code);
361 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
364 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
366 return MC_random(min, max);
369 /* ************************************************************************** */
371 /** @brief returns a printable string representing a simcall */
372 const char* SIMIX_simcall_name(Simcall kind)
374 return simcall_names[static_cast<int>(kind)];
380 void unblock(smx_actor_t actor)
382 xbt_assert(SIMIX_is_maestro());
383 actor->simcall_answer();
386 } // namespace simgrid