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"
23 #include "src/simix/smx_host_private.hpp"
25 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
27 #include "popping_bodies.cpp"
30 * @ingroup simix_process_management
31 * @brief Creates a synchro that may involve parallel computation on
32 * several hosts and communication between them.
34 * @param name Name of the execution synchro to create
35 * @param host_nb Number of hosts where the synchro will be executed
36 * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
37 * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
38 * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
39 * amount between each pair of hosts
40 * @param rate the SURF action rate
41 * @param timeout timeout
42 * @return A new SIMIX execution synchronization
44 smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
45 const double* flops_amount, const double* bytes_amount, double rate,
48 /* checking for infinite values */
49 for (int i = 0 ; i < host_nb ; ++i) {
50 if (flops_amount != nullptr)
51 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
52 if (bytes_amount != nullptr) {
53 for (int j = 0 ; j < host_nb ; ++j) {
54 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
55 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
60 xbt_assert(std::isfinite(rate), "rate is not finite!");
62 return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
63 return SIMIX_execution_parallel_start(std::move(name), host_nb, host_list, flops_amount, bytes_amount, rate,
69 * @ingroup simix_host_management
70 * @brief Waits for the completion of an execution synchro and destroy it.
72 * @param execution The execution synchro
74 e_smx_state_t simcall_execution_wait(const smx_activity_t& execution)
76 return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
79 e_smx_state_t simcall_execution_test(const smx_activity_t& execution)
81 return (e_smx_state_t)simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
84 void simcall_process_join(smx_actor_t process, double timeout)
86 simcall_BODY_process_join(process, timeout);
90 * @ingroup simix_process_management
91 * @brief Suspends an actor
93 void simcall_process_suspend(smx_actor_t process)
95 simcall_BODY_process_suspend(process);
99 * @ingroup simix_process_management
100 * @brief Creates a new sleep SIMIX synchro.
102 * This function creates a SURF action and allocates the data necessary
103 * to create the SIMIX synchro. It can raise a HostFailureException if the
104 * host crashed. The default SIMIX name of the synchro is "sleep".
106 * @param duration Time duration of the sleep.
107 * @return A result telling whether the sleep was successful
109 e_smx_state_t simcall_process_sleep(double duration)
111 /* checking for infinite values */
112 xbt_assert(std::isfinite(duration), "duration is not finite!");
113 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
117 * @ingroup simix_comm_management
119 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
120 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
121 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
124 /* checking for infinite values */
125 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
126 xbt_assert(std::isfinite(rate), "rate is not finite!");
127 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
129 xbt_assert(mbox, "No rendez-vous point defined for send");
131 if (MC_is_active() || MC_record_replay_is_active()) {
132 /* the model-checker wants two separate simcalls */
133 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
134 comm = simcall_comm_isend(sender, mbox, task_size, rate,
135 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
136 simcall_comm_wait(comm, timeout);
140 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
141 match_fun, copy_data_fun, data, timeout);
146 * @ingroup simix_comm_management
148 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
149 size_t src_buff_size,
150 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
151 void (*clean_fun)(void*),
152 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
153 void* data, int detached)
155 /* checking for infinite values */
156 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
157 xbt_assert(std::isfinite(rate), "rate is not finite!");
159 xbt_assert(mbox, "No rendez-vous point defined for isend");
161 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
162 src_buff_size, match_fun,
163 clean_fun, copy_data_fun, data, detached);
167 * @ingroup simix_comm_management
169 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
170 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
171 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
172 double timeout, double rate)
174 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
175 xbt_assert(mbox, "No rendez-vous point defined for recv");
177 if (MC_is_active() || MC_record_replay_is_active()) {
178 /* the model-checker wants two separate simcalls */
179 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
180 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
181 match_fun, copy_data_fun, data, rate);
182 simcall_comm_wait(comm, timeout);
186 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
187 match_fun, copy_data_fun, data, timeout, rate);
191 * @ingroup simix_comm_management
193 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
194 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
195 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
196 void* data, double rate)
198 xbt_assert(mbox, "No rendez-vous point defined for irecv");
200 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
201 match_fun, copy_data_fun, data, rate);
205 * @ingroup simix_comm_management
207 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
208 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
210 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
212 return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
216 * @ingroup simix_comm_management
218 unsigned int simcall_comm_waitany(smx_activity_t* comms, size_t count, double timeout)
220 return simcall_BODY_comm_waitany(comms, count, timeout);
224 * @ingroup simix_comm_management
226 int simcall_comm_testany(smx_activity_t comms[], size_t count)
230 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
231 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t comm) {
232 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
234 return simcall_BODY_comm_testany(rcomms.get(), count);
238 * @ingroup simix_comm_management
240 void simcall_comm_wait(const smx_activity_t& comm, double timeout)
242 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
243 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
247 * @ingroup simix_comm_management
250 int simcall_comm_test(const smx_activity_t& comm)
252 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
256 * @ingroup simix_synchro_management
259 smx_mutex_t simcall_mutex_init()
261 if (simix_global == nullptr) {
262 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
263 // get there before the initialization
266 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
270 * @ingroup simix_synchro_management
273 void simcall_mutex_lock(smx_mutex_t mutex)
275 simcall_BODY_mutex_lock(mutex);
279 * @ingroup simix_synchro_management
282 int simcall_mutex_trylock(smx_mutex_t mutex)
284 return simcall_BODY_mutex_trylock(mutex);
288 * @ingroup simix_synchro_management
291 void simcall_mutex_unlock(smx_mutex_t mutex)
293 simcall_BODY_mutex_unlock(mutex);
297 * @ingroup simix_synchro_management
300 smx_cond_t simcall_cond_init()
302 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
306 * @ingroup simix_synchro_management
309 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
311 simcall_BODY_cond_wait(cond, mutex);
315 * @ingroup simix_synchro_management
318 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
320 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
321 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
325 * @ingroup simix_synchro_management
328 void simcall_sem_acquire(smx_sem_t sem)
330 simcall_BODY_sem_acquire(sem);
334 * @ingroup simix_synchro_management
337 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
339 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
340 return simcall_BODY_sem_acquire_timeout(sem, timeout);
343 e_smx_state_t simcall_io_wait(const smx_activity_t& io)
345 return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
348 void simcall_run_kernel(std::function<void()> const& code)
350 simcall_BODY_run_kernel(&code);
353 void simcall_run_blocking(std::function<void()> const& code)
355 simcall_BODY_run_blocking(&code);
358 int simcall_mc_random(int min, int max) {
359 return simcall_BODY_mc_random(min, max);
362 /* ************************************************************************** */
364 /** @brief returns a printable string representing a simcall */
365 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
366 return simcall_names[kind];
372 void unblock(smx_actor_t process)
374 xbt_assert(SIMIX_is_maestro());
375 SIMIX_simcall_answer(&process->simcall);
378 } // namespace simgrid
380 /* ****************************DEPRECATED CALLS******************************* */
381 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
383 simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
385 void simcall_comm_cancel(smx_activity_t comm)
387 simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
389 void simcall_execution_cancel(smx_activity_t exec)
391 simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
393 void simcall_execution_set_priority(smx_activity_t exec, double priority)
395 simgrid::simix::simcall([exec, priority] {
396 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_priority(priority);
400 void simcall_execution_set_bound(smx_activity_t exec, double bound)
402 simgrid::simix::simcall(
403 [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
406 smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
407 double priority, double bound, sg_host_t host)
409 return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
410 return simgrid::kernel::activity::ExecImplPtr(
411 new simgrid::kernel::activity::ExecImpl(std::move(name), std::move(category), nullptr, host))
412 ->start(flops_amount, priority, bound);
417 void SIMIX_comm_finish(smx_activity_t synchro)
419 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();