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 e_smx_state_t simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout)
34 return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution),
38 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
40 return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
43 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
45 return simcall_BODY_execution_waitany_for(execs, count, timeout);
48 void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
50 simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
53 void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
55 process->iface()->suspend();
58 e_smx_state_t simcall_process_sleep(double duration) // XBT_DEPRECATED_v329
60 simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
61 return simgrid::kernel::activity::State::DONE;
65 * @ingroup simix_comm_management
67 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
68 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
69 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
72 /* checking for infinite values */
73 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
74 xbt_assert(std::isfinite(rate), "rate is not finite!");
75 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
77 xbt_assert(mbox, "No rendez-vous point defined for send");
79 if (MC_is_active() || MC_record_replay_is_active()) {
80 /* the model-checker wants two separate simcalls */
81 simgrid::kernel::activity::ActivityImplPtr comm =
82 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
83 comm = simcall_comm_isend(sender, mbox, task_size, rate,
84 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
85 simcall_comm_wait(comm.get(), timeout);
89 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
90 match_fun, copy_data_fun, data, timeout);
95 * @ingroup simix_comm_management
97 simgrid::kernel::activity::ActivityImplPtr
98 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
99 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
100 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
101 void* data, bool detached)
103 /* checking for infinite values */
104 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
105 xbt_assert(std::isfinite(rate), "rate is not finite!");
107 xbt_assert(mbox, "No rendez-vous point defined for isend");
109 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
110 match_fun, clean_fun, copy_data_fun, data, detached);
114 * @ingroup simix_comm_management
116 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
117 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
118 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
119 double timeout, double rate)
121 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
122 xbt_assert(mbox, "No rendez-vous point defined for recv");
124 if (MC_is_active() || MC_record_replay_is_active()) {
125 /* the model-checker wants two separate simcalls */
126 simgrid::kernel::activity::ActivityImplPtr comm =
127 nullptr; /* MC needs the comm to be set to nullptr during the simcall */
128 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
129 match_fun, copy_data_fun, data, rate);
130 simcall_comm_wait(comm.get(), timeout);
134 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
135 copy_data_fun, data, timeout, rate);
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, double rate)
146 xbt_assert(mbox, "No rendez-vous point defined for irecv");
148 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
149 copy_data_fun, data, rate);
153 * @ingroup simix_comm_management
155 simgrid::kernel::activity::ActivityImplPtr
156 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
157 void* data) // XBT_ATTRIB_DEPRECATED_v330
159 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
161 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
165 * @ingroup simix_comm_management
167 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
168 double timeout) // XBT_ATTRIB_DEPRECATED_v330
170 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
171 std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
172 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
174 return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
177 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
179 return simcall_BODY_comm_waitany(comms, count, timeout);
183 * @ingroup simix_comm_management
185 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
189 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
190 std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
191 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
193 return simcall_BODY_comm_testany(rcomms.get(), count);
196 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
200 return simcall_BODY_comm_testany(comms, count);
204 * @ingroup simix_comm_management
206 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
208 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
209 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
213 * @ingroup simix_comm_management
216 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
218 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
222 * @ingroup simix_synchro_management
225 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
227 if (simix_global == nullptr) {
228 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
229 // get there before the initialization
232 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
236 * @ingroup simix_synchro_management
239 void simcall_mutex_lock(smx_mutex_t mutex)
241 simcall_BODY_mutex_lock(mutex);
245 * @ingroup simix_synchro_management
248 int simcall_mutex_trylock(smx_mutex_t mutex)
250 return simcall_BODY_mutex_trylock(mutex);
254 * @ingroup simix_synchro_management
257 void simcall_mutex_unlock(smx_mutex_t mutex)
259 simcall_BODY_mutex_unlock(mutex);
263 * @ingroup simix_synchro_management
266 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
268 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
272 * @ingroup simix_synchro_management
275 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
277 simcall_BODY_cond_wait(cond, mutex);
281 * @ingroup simix_synchro_management
284 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
286 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
287 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
291 * @ingroup simix_synchro_management
294 void simcall_sem_acquire(smx_sem_t sem)
296 simcall_BODY_sem_acquire(sem);
300 * @ingroup simix_synchro_management
303 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
305 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
306 return simcall_BODY_sem_acquire_timeout(sem, timeout);
309 e_smx_state_t simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout)
311 return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io), timeout);
314 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io)
316 return simcall_BODY_io_test(static_cast<simgrid::kernel::activity::IoImpl*>(io));
319 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
321 simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
322 simcall_BODY_run_kernel(&code);
325 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
327 simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
328 simcall_BODY_run_blocking(&code);
331 int simcall_mc_random(int min, int max) {
332 return simcall_BODY_mc_random(min, max);
335 /* ************************************************************************** */
337 /** @brief returns a printable string representing a simcall */
338 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
339 return simcall_names[kind];
345 void unblock(smx_actor_t actor)
347 xbt_assert(SIMIX_is_maestro());
348 actor->simcall_answer();
351 } // namespace simgrid