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-2022. 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/EngineImpl.hpp"
15 #include "src/kernel/activity/CommImpl.hpp"
16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
17 #include "src/kernel/activity/MutexImpl.hpp"
18 #include "src/kernel/activity/SemaphoreImpl.hpp"
19 #include "src/kernel/actor/SimcallObserver.hpp"
20 #include "src/mc/mc_replay.hpp"
21 #include "xbt/random.hpp"
22 #include <simgrid/Exception.hpp>
23 #include <simgrid/s4u/Activity.hpp>
25 #include <boost/core/demangle.hpp>
29 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
32 * @ingroup simix_comm_management
34 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
35 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
36 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
39 /* checking for infinite values */
40 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
41 xbt_assert(std::isfinite(rate), "rate is not finite!");
42 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
44 xbt_assert(mbox, "No rendez-vous point defined for send");
46 if (MC_is_active() || MC_record_replay_is_active()) {
47 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
48 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
50 simgrid::kernel::actor::CommIsendSimcall send_observer{
51 sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
52 nullptr, copy_data_fun, data, false};
53 comm = simgrid::kernel::actor::simcall_answered(
54 [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
56 simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
57 if (simgrid::kernel::actor::simcall_blocking(
59 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
62 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
67 simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
68 static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
69 nullptr, copy_data_fun, data, false);
70 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
71 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
72 comm->wait_for(observer.get_issuer(), timeout);
78 * @ingroup simix_comm_management
80 simgrid::kernel::activity::ActivityImplPtr
81 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
82 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
83 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
84 void* data, bool detached) // XBT_ATTRIB_DEPRECATED_v335
86 /* checking for infinite values */
87 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
88 xbt_assert(std::isfinite(rate), "rate is not finite!");
90 xbt_assert(mbox, "No rendez-vous point defined for isend");
92 simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
93 static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
94 clean_fun, copy_data_fun, data, detached);
95 return simgrid::kernel::actor::simcall_answered(
96 [&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
100 * @ingroup simix_comm_management
102 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
103 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
104 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
105 double timeout, double rate)
107 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
108 xbt_assert(mbox, "No rendez-vous point defined for recv");
110 if (MC_is_active() || MC_record_replay_is_active()) {
111 /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
112 simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
114 simgrid::kernel::actor::CommIrecvSimcall observer{
115 receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun, copy_data_fun, data, rate};
116 comm = simgrid::kernel::actor::simcall_answered(
117 [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
119 simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
120 if (simgrid::kernel::actor::simcall_blocking(
122 wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
125 throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
130 simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
131 dst_buff_size, match_fun, copy_data_fun, data, rate);
132 simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
133 simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
134 comm->wait_for(observer.get_issuer(), timeout);
139 * @ingroup simix_comm_management
141 simgrid::kernel::activity::ActivityImplPtr
142 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
143 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
144 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
145 double rate) // XBT_ATTRIB_DEPRECATED_v335
147 xbt_assert(mbox, "No rendez-vous point defined for irecv");
149 simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
150 dst_buff_size, match_fun, copy_data_fun, data, rate);
151 return simgrid::kernel::actor::simcall_answered(
152 [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
156 * @ingroup simix_comm_management
158 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
159 double timeout) // XBT_ATTRIB_DEPRECATED_v335
161 std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
162 for (size_t i = 0; i < count; i++)
163 activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
164 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
165 simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
166 ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
168 simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
169 observer.get_timeout());
172 if (changed_pos != -1)
173 activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
178 * @ingroup simix_comm_management
180 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
184 std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
185 for (size_t i = 0; i < count; i++)
186 activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
188 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
189 simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
190 ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
192 simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
195 if (changed_pos != -1)
196 comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
201 * @ingroup simix_comm_management
203 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout) // XBT_ATTRIB_DEPRECATED_v335
205 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
206 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
207 simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
211 * @ingroup simix_comm_management
214 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
216 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
217 simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
218 if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
220 comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
226 static void simcall(simgrid::simix::Simcall call, std::function<void()> const& code)
228 auto self = simgrid::kernel::actor::ActorImpl::self();
229 self->simcall_.call_ = call;
230 self->simcall_.code_ = &code;
231 if (not simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
232 XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), SIMIX_simcall_name(self->simcall_));
235 self->simcall_handle(0);
239 void simcall_run_answered(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
241 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
242 // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
243 // and simcall_answer() is called
244 simcall(simgrid::simix::Simcall::RUN_ANSWERED, code);
245 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
248 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
250 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
251 // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
252 // BUT simcall_answer IS NOT CALLED
253 simcall(simgrid::simix::Simcall::RUN_BLOCKING, code);
254 simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;