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-2019. 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(const smx_activity_t& execution)
34 return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
37 bool simcall_execution_test(const smx_activity_t& execution)
39 return simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
42 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
44 return simcall_BODY_execution_waitany_for(execs, count, timeout);
47 void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
49 SIMIX_process_self()->join(process, timeout);
52 void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
54 process->iface()->suspend();
57 e_smx_state_t simcall_process_sleep(double duration) // XBT_DEPRECATED_v329
59 SIMIX_process_self()->sleep(duration);
64 * @ingroup simix_comm_management
66 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
67 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
68 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
71 /* checking for infinite values */
72 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
73 xbt_assert(std::isfinite(rate), "rate is not finite!");
74 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
76 xbt_assert(mbox, "No rendez-vous point defined for send");
78 if (MC_is_active() || MC_record_replay_is_active()) {
79 /* the model-checker wants two separate simcalls */
80 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
81 comm = simcall_comm_isend(sender, mbox, task_size, rate,
82 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
83 simcall_comm_wait(comm, timeout);
87 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
88 match_fun, copy_data_fun, data, timeout);
93 * @ingroup simix_comm_management
95 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
97 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
98 void (*clean_fun)(void*),
99 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
100 void* data, bool detached)
102 /* checking for infinite values */
103 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
104 xbt_assert(std::isfinite(rate), "rate is not finite!");
106 xbt_assert(mbox, "No rendez-vous point defined for isend");
108 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
109 match_fun, clean_fun, copy_data_fun, data, detached);
113 * @ingroup simix_comm_management
115 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
116 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
117 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
118 double timeout, double rate)
120 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
121 xbt_assert(mbox, "No rendez-vous point defined for recv");
123 if (MC_is_active() || MC_record_replay_is_active()) {
124 /* the model-checker wants two separate simcalls */
125 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
126 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
127 match_fun, copy_data_fun, data, rate);
128 simcall_comm_wait(comm, timeout);
132 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
133 copy_data_fun, data, timeout, rate);
137 * @ingroup simix_comm_management
139 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
140 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
141 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
142 void* data, double rate)
144 xbt_assert(mbox, "No rendez-vous point defined for irecv");
146 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
147 copy_data_fun, data, rate);
151 * @ingroup simix_comm_management
153 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
154 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
156 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
158 return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
162 * @ingroup simix_comm_management
164 unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout)
166 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
167 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
168 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
170 return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
173 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
175 return simcall_BODY_comm_waitany(comms, count, timeout);
179 * @ingroup simix_comm_management
181 int simcall_comm_testany(smx_activity_t comms[], size_t count)
185 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
186 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
187 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
189 return simcall_BODY_comm_testany(rcomms.get(), count);
192 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
196 return simcall_BODY_comm_testany(comms, count);
200 * @ingroup simix_comm_management
202 void simcall_comm_wait(const smx_activity_t& comm, double timeout)
204 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
205 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
209 * @ingroup simix_comm_management
212 bool simcall_comm_test(const smx_activity_t& comm)
214 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
218 * @ingroup simix_synchro_management
221 smx_mutex_t simcall_mutex_init()
223 if (simix_global == nullptr) {
224 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
225 // get there before the initialization
228 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
232 * @ingroup simix_synchro_management
235 void simcall_mutex_lock(smx_mutex_t mutex)
237 simcall_BODY_mutex_lock(mutex);
241 * @ingroup simix_synchro_management
244 int simcall_mutex_trylock(smx_mutex_t mutex)
246 return simcall_BODY_mutex_trylock(mutex);
250 * @ingroup simix_synchro_management
253 void simcall_mutex_unlock(smx_mutex_t mutex)
255 simcall_BODY_mutex_unlock(mutex);
259 * @ingroup simix_synchro_management
262 smx_cond_t simcall_cond_init()
264 return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
268 * @ingroup simix_synchro_management
271 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
273 simcall_BODY_cond_wait(cond, mutex);
277 * @ingroup simix_synchro_management
280 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
282 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
283 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
287 * @ingroup simix_synchro_management
290 void simcall_sem_acquire(smx_sem_t sem)
292 simcall_BODY_sem_acquire(sem);
296 * @ingroup simix_synchro_management
299 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
301 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
302 return simcall_BODY_sem_acquire_timeout(sem, timeout);
305 e_smx_state_t simcall_io_wait(const smx_activity_t& io)
307 return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
310 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
312 SIMIX_process_self()->simcall.inspector_ = t;
313 simcall_BODY_run_kernel(&code);
316 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
318 SIMIX_process_self()->simcall.inspector_ = t;
319 simcall_BODY_run_blocking(&code);
322 int simcall_mc_random(int min, int max) {
323 return simcall_BODY_mc_random(min, max);
326 /* ************************************************************************** */
328 /** @brief returns a printable string representing a simcall */
329 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
330 return simcall_names[kind];
336 void unblock(smx_actor_t actor)
338 xbt_assert(SIMIX_is_maestro());
339 actor->simcall_answer();
342 } // namespace simgrid