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-2020. 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 "simgrid/simix/blocking_simcall.hpp"
15 #include "src/kernel/activity/CommImpl.hpp"
16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
17 #include "src/kernel/activity/ExecImpl.hpp"
18 #include "src/kernel/activity/IoImpl.hpp"
19 #include "src/kernel/activity/MailboxImpl.hpp"
20 #include "src/kernel/activity/MutexImpl.hpp"
21 #include "src/mc/mc_replay.hpp"
22 #include "src/plugins/vm/VirtualMachineImpl.hpp"
24 #include "popping_bodies.cpp"
27 * @ingroup simix_host_management
28 * @brief Waits for the completion of an execution synchro and destroy it.
30 * @param execution The execution synchro
32 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
33 double timeout) // XBT_ATTRIB_DEPRECATED_v330
35 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
36 simgrid::kernel::actor::simcall_blocking<void>(
37 [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
38 return simgrid::kernel::activity::State::DONE;
41 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
42 double timeout) // XBT_ATTRIB_DEPRECATED_v330
44 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
45 simgrid::kernel::actor::simcall_blocking<void>(
46 [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, double timeout)
62 return simcall_BODY_execution_waitany_for(execs, count, timeout);
65 void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
67 simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
70 void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
72 process->iface()->suspend();
75 simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
77 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
78 return simgrid::kernel::activity::State::DONE;
82 * @ingroup simix_comm_management
84 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
85 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
86 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
89 /* checking for infinite values */
90 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
91 xbt_assert(std::isfinite(rate), "rate is not finite!");
92 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
94 xbt_assert(mbox, "No rendez-vous point defined for send");
96 if (MC_is_active() || MC_record_replay_is_active()) {
97 /* the model-checker wants two separate simcalls */
98 simgrid::kernel::activity::ActivityImplPtr comm =
99 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
100 comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
102 simcall_comm_wait(comm.get(), timeout);
106 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
107 match_fun, copy_data_fun, data, timeout);
112 * @ingroup simix_comm_management
114 simgrid::kernel::activity::ActivityImplPtr
115 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
116 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
117 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
118 void* data, bool detached)
120 /* checking for infinite values */
121 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
122 xbt_assert(std::isfinite(rate), "rate is not finite!");
124 xbt_assert(mbox, "No rendez-vous point defined for isend");
126 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
127 match_fun, clean_fun, copy_data_fun, data, detached);
131 * @ingroup simix_comm_management
133 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
134 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
135 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
136 double timeout, double rate)
138 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
139 xbt_assert(mbox, "No rendez-vous point defined for recv");
141 if (MC_is_active() || MC_record_replay_is_active()) {
142 /* the model-checker wants two separate simcalls */
143 simgrid::kernel::activity::ActivityImplPtr comm =
144 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
145 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
146 match_fun, copy_data_fun, data, rate);
147 simcall_comm_wait(comm.get(), timeout);
151 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
152 copy_data_fun, data, timeout, rate);
156 * @ingroup simix_comm_management
158 simgrid::kernel::activity::ActivityImplPtr
159 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
160 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
161 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
163 xbt_assert(mbox, "No rendez-vous point defined for irecv");
165 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
166 copy_data_fun, data, rate);
170 * @ingroup simix_comm_management
172 simgrid::kernel::activity::ActivityImplPtr
173 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
174 void* data) // XBT_ATTRIB_DEPRECATED_v330
176 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
178 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
182 * @ingroup simix_comm_management
184 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
185 double timeout) // XBT_ATTRIB_DEPRECATED_v330
187 auto rcomms = std::make_unique<simgrid::kernel::activity::CommImpl*[]>(count);
188 std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
189 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
191 return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
194 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
196 return simcall_BODY_comm_waitany(comms, count, timeout);
200 * @ingroup simix_comm_management
202 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
206 auto rcomms = std::make_unique<simgrid::kernel::activity::CommImpl*[]>(count);
207 std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
208 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
210 return simcall_BODY_comm_testany(rcomms.get(), count);
213 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
217 return simcall_BODY_comm_testany(comms, count);
221 * @ingroup simix_comm_management
223 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
225 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
226 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
230 * @ingroup simix_comm_management
233 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
235 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
239 * @ingroup simix_synchro_management
242 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
244 if (simix_global == nullptr) {
245 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
246 // get there before the initialization
249 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
253 * @ingroup simix_synchro_management
256 void simcall_mutex_lock(smx_mutex_t mutex)
258 simcall_BODY_mutex_lock(mutex);
262 * @ingroup simix_synchro_management
265 int simcall_mutex_trylock(smx_mutex_t mutex)
267 return simcall_BODY_mutex_trylock(mutex);
271 * @ingroup simix_synchro_management
274 void simcall_mutex_unlock(smx_mutex_t mutex)
276 simcall_BODY_mutex_unlock(mutex);
280 * @ingroup simix_synchro_management
283 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
285 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
289 * @ingroup simix_synchro_management
292 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
294 simcall_BODY_cond_wait(cond, mutex);
298 * @ingroup simix_synchro_management
301 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
303 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
304 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
308 * @ingroup simix_synchro_management
311 void simcall_sem_acquire(smx_sem_t sem)
313 simcall_BODY_sem_acquire(sem);
317 * @ingroup simix_synchro_management
320 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
322 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
323 return simcall_BODY_sem_acquire_timeout(sem, timeout);
326 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
327 double timeout) // XBT_ATTRIB_DEPRECATED_v330
329 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
330 simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
331 return simgrid::kernel::activity::State::DONE;
334 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
335 double timeout) // XBT_ATTRIB_DEPRECATED_v330
337 simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
338 simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
339 return simgrid::kernel::activity::State::DONE;
342 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
344 return simgrid::kernel::actor::simcall([io] { return io->test(); });
347 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
349 return simgrid::kernel::actor::simcall([io] { return io->test(); });
352 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
354 simgrid::kernel::actor::ActorImpl::self()->simcall_.inspector_ = t;
355 simcall_BODY_run_kernel(&code);
358 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
360 simgrid::kernel::actor::ActorImpl::self()->simcall_.inspector_ = t;
361 simcall_BODY_run_blocking(&code);
364 int simcall_mc_random(int min, int max) {
365 return simcall_BODY_mc_random(min, max);
368 /* ************************************************************************** */
370 /** @brief returns a printable string representing a simcall */
371 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
372 return simcall_names[kind];
378 void unblock(smx_actor_t actor)
380 xbt_assert(SIMIX_is_maestro());
381 actor->simcall_answer();
384 } // namespace simgrid