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-2023. 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. */
13 #include "simgrid/config.h"
14 #include "simgrid/modelchecker.h"
15 #include "src/kernel/EngineImpl.hpp"
16 #include "src/kernel/activity/CommImpl.hpp"
17 #include "src/kernel/actor/SimcallObserver.hpp"
18 #include "src/mc/mc_replay.hpp"
19 #include <simgrid/s4u/Activity.hpp>
21 #define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v335)
22 #include <simgrid/simix.h>
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_simcall, kernel, "transmuting from user request into kernel handlers");
26 void simcall_comm_send(simgrid::kernel::actor::ActorImpl* sender, simgrid::kernel::activity::MailboxImpl* mbox,
27 double task_size, double rate, void* src_buff, size_t src_buff_size,
28 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
29 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
30 double timeout) // XBT_ATTRIB_DEPRECATED_v335
32 xbt_assert(mbox, "No rendez-vous point defined for send");
33 simgrid::s4u::Comm::send(sender, mbox->get_iface(), task_size, rate, src_buff, src_buff_size, match_fun,
34 copy_data_fun, data, timeout);
37 simgrid::kernel::activity::ActivityImplPtr
38 simcall_comm_isend(simgrid::kernel::actor::ActorImpl* sender, simgrid::kernel::activity::MailboxImpl* mbox,
39 double task_size, double rate, void* src_buff, size_t src_buff_size,
40 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void (*clean_fun)(void*),
41 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
42 bool detached) // XBT_ATTRIB_DEPRECATED_v335
44 /* checking for infinite values */
45 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
46 xbt_assert(std::isfinite(rate), "rate is not finite!");
48 xbt_assert(mbox, "No rendez-vous point defined for isend");
50 simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
51 static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
52 clean_fun, copy_data_fun, data, detached);
53 return simgrid::kernel::actor::simcall_answered(
54 [&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
57 void simcall_comm_recv(simgrid::kernel::actor::ActorImpl* receiver, simgrid::kernel::activity::MailboxImpl* mbox,
58 void* dst_buff, size_t* dst_buff_size,
59 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
60 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
61 double timeout, double rate) // XBT_ATTRIB_DEPRECATED_v335
63 xbt_assert(mbox, "No rendez-vous point defined for recv");
64 simgrid::s4u::Comm::recv(receiver, mbox->get_iface(), dst_buff, dst_buff_size, match_fun, copy_data_fun, data,
68 simgrid::kernel::activity::ActivityImplPtr
69 simcall_comm_irecv(simgrid::kernel::actor::ActorImpl* receiver, simgrid::kernel::activity::MailboxImpl* mbox,
70 void* dst_buff, size_t* dst_buff_size,
71 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
72 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
73 double rate) // XBT_ATTRIB_DEPRECATED_v335
75 xbt_assert(mbox, "No rendez-vous point defined for irecv");
77 simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
78 dst_buff_size, match_fun, copy_data_fun, data, rate);
79 return simgrid::kernel::actor::simcall_answered(
80 [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
83 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
84 double timeout) // XBT_ATTRIB_DEPRECATED_v335
86 std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
87 for (size_t i = 0; i < count; i++)
88 activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
89 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
90 simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
91 ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
93 simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
94 observer.get_timeout());
97 if (changed_pos != -1)
98 activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
102 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
106 std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
107 for (size_t i = 0; i < count; i++)
108 activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
110 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
111 simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
112 ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
114 simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
117 if (changed_pos != -1)
118 comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
122 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout) // XBT_ATTRIB_DEPRECATED_v335
124 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
125 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
126 simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
129 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
131 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
132 simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
133 if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
135 comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
141 static void simcall(simgrid::kernel::actor::Simcall::Type call, std::function<void()> const& code,
142 simgrid::kernel::actor::SimcallObserver* observer)
144 auto self = simgrid::kernel::actor::ActorImpl::self();
145 self->simcall_.call_ = call;
146 self->simcall_.code_ = &code;
147 self->simcall_.observer_ = observer;
148 if (simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
149 self->simcall_handle(0);
151 XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), self->simcall_.get_cname());
154 self->simcall_.observer_ = nullptr;
157 void simcall_run_answered(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
159 // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
160 // and simcall_answer() is called
161 simcall(simgrid::kernel::actor::Simcall::Type::RUN_ANSWERED, code, observer);
164 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
166 // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
167 // BUT simcall_answer IS NOT CALLED
168 simcall(simgrid::kernel::actor::Simcall::Type::RUN_BLOCKING, code, observer);
171 void simcall_run_object_access(std::function<void()> const& code, simgrid::kernel::actor::ObjectAccessSimcallItem* item)
173 auto self = simgrid::kernel::actor::ActorImpl::self();
175 // We only need a simcall if the order of the setters is important (parallel run or MC execution).
176 // Otherwise, just call the function with no simcall
178 if (simgrid::kernel::context::Context::is_parallel()
180 || MC_is_active() || MC_record_replay_is_active()
183 simgrid::kernel::actor::ObjectAccessSimcallObserver observer{self, item};
184 simcall(simgrid::kernel::actor::Simcall::Type::RUN_ANSWERED, code, &observer);
185 item->take_ownership();
187 // don't return from the context-switch we don't do
188 self->simcall_.call_ = simgrid::kernel::actor::Simcall::Type::RUN_BLOCKING;
189 self->simcall_.code_ = &code;
190 self->simcall_.observer_ = nullptr;
191 self->simcall_handle(0);