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)
49 simcall_BODY_process_join(process, timeout);
53 * @ingroup simix_process_management
54 * @brief Suspends an actor
56 void simcall_process_suspend(smx_actor_t process)
58 simcall_BODY_process_suspend(process);
62 * @ingroup simix_process_management
63 * @brief Creates a new sleep SIMIX synchro.
65 * This function creates a SURF action and allocates the data necessary
66 * to create the SIMIX synchro. It can raise a HostFailureException if the
67 * host crashed. The default SIMIX name of the synchro is "sleep".
69 * @param duration Time duration of the sleep.
70 * @return A result telling whether the sleep was successful
72 e_smx_state_t simcall_process_sleep(double duration)
74 /* checking for infinite values */
75 xbt_assert(std::isfinite(duration), "duration is not finite!");
76 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
80 * @ingroup simix_comm_management
82 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
83 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
84 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
87 /* checking for infinite values */
88 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
89 xbt_assert(std::isfinite(rate), "rate is not finite!");
90 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
92 xbt_assert(mbox, "No rendez-vous point defined for send");
94 if (MC_is_active() || MC_record_replay_is_active()) {
95 /* the model-checker wants two separate simcalls */
96 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
97 comm = simcall_comm_isend(sender, mbox, task_size, rate,
98 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
99 simcall_comm_wait(comm, timeout);
103 simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
104 match_fun, copy_data_fun, data, timeout);
109 * @ingroup simix_comm_management
111 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
112 size_t src_buff_size,
113 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
114 void (*clean_fun)(void*),
115 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
116 void* data, bool detached)
118 /* checking for infinite values */
119 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
120 xbt_assert(std::isfinite(rate), "rate is not finite!");
122 xbt_assert(mbox, "No rendez-vous point defined for isend");
124 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
125 match_fun, clean_fun, copy_data_fun, data, detached);
129 * @ingroup simix_comm_management
131 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
132 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
133 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
134 double timeout, double rate)
136 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
137 xbt_assert(mbox, "No rendez-vous point defined for recv");
139 if (MC_is_active() || MC_record_replay_is_active()) {
140 /* the model-checker wants two separate simcalls */
141 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
142 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
143 match_fun, copy_data_fun, data, rate);
144 simcall_comm_wait(comm, timeout);
148 simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
149 copy_data_fun, data, timeout, rate);
153 * @ingroup simix_comm_management
155 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
156 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
157 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
158 void* data, double rate)
160 xbt_assert(mbox, "No rendez-vous point defined for irecv");
162 return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
163 copy_data_fun, data, rate);
167 * @ingroup simix_comm_management
169 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
170 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
172 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
174 return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
178 * @ingroup simix_comm_management
180 unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout)
182 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
183 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
184 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
186 return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
189 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
191 return simcall_BODY_comm_waitany(comms, count, timeout);
195 * @ingroup simix_comm_management
197 int simcall_comm_testany(smx_activity_t comms[], size_t count)
201 std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
202 std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
203 return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
205 return simcall_BODY_comm_testany(rcomms.get(), count);
208 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
212 return simcall_BODY_comm_testany(comms, count);
216 * @ingroup simix_comm_management
218 void simcall_comm_wait(const smx_activity_t& comm, double timeout)
220 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
221 simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
225 * @ingroup simix_comm_management
228 bool simcall_comm_test(const smx_activity_t& comm)
230 return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
234 * @ingroup simix_synchro_management
237 smx_mutex_t simcall_mutex_init()
239 if (simix_global == nullptr) {
240 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
241 // get there before the initialization
244 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
248 * @ingroup simix_synchro_management
251 void simcall_mutex_lock(smx_mutex_t mutex)
253 simcall_BODY_mutex_lock(mutex);
257 * @ingroup simix_synchro_management
260 int simcall_mutex_trylock(smx_mutex_t mutex)
262 return simcall_BODY_mutex_trylock(mutex);
266 * @ingroup simix_synchro_management
269 void simcall_mutex_unlock(smx_mutex_t mutex)
271 simcall_BODY_mutex_unlock(mutex);
275 * @ingroup simix_synchro_management
278 smx_cond_t simcall_cond_init()
280 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
284 * @ingroup simix_synchro_management
287 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
289 simcall_BODY_cond_wait(cond, mutex);
293 * @ingroup simix_synchro_management
296 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
298 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
299 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
303 * @ingroup simix_synchro_management
306 void simcall_sem_acquire(smx_sem_t sem)
308 simcall_BODY_sem_acquire(sem);
312 * @ingroup simix_synchro_management
315 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
317 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
318 return simcall_BODY_sem_acquire_timeout(sem, timeout);
321 e_smx_state_t simcall_io_wait(const smx_activity_t& io)
323 return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
326 void simcall_run_kernel(std::function<void()> const& code)
328 simcall_BODY_run_kernel(&code);
331 void simcall_run_blocking(std::function<void()> const& code)
333 simcall_BODY_run_blocking(&code);
336 int simcall_mc_random(int min, int max) {
337 return simcall_BODY_mc_random(min, max);
340 /* ************************************************************************** */
342 /** @brief returns a printable string representing a simcall */
343 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
344 return simcall_names[kind];
350 void unblock(smx_actor_t process)
352 xbt_assert(SIMIX_is_maestro());
353 SIMIX_simcall_answer(&process->simcall);
356 } // namespace simgrid
358 /* ****************************DEPRECATED CALLS******************************* */
359 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
361 simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
363 void simcall_comm_cancel(smx_activity_t comm)
365 simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
367 void simcall_execution_cancel(smx_activity_t exec)
369 simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
372 void simcall_execution_set_bound(smx_activity_t exec, double bound)
374 simgrid::simix::simcall(
375 [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
379 smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
380 double sharing_penalty, double bound, sg_host_t host)
382 return simgrid::simix::simcall([name, category, flops_amount, sharing_penalty, bound, host] {
383 simgrid::kernel::activity::ExecImpl* exec = new simgrid::kernel::activity::ExecImpl();
386 .set_tracing_category(category)
388 .set_sharing_penalty(sharing_penalty)
390 .set_flops_amount(flops_amount)
392 return simgrid::kernel::activity::ExecImplPtr(exec);
397 smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
398 const double* flops_amount, const double* bytes_amount, double rate,
401 /* Check that we are not mixing VMs and PMs in the parallel task */
402 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
403 for (int i = 1; i < host_nb; i++) {
404 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
405 xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
408 /* checking for infinite values */
409 for (int i = 0; i < host_nb; ++i) {
410 if (flops_amount != nullptr)
411 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
412 if (bytes_amount != nullptr) {
413 for (int j = 0; j < host_nb; ++j) {
414 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]), "bytes_amount[%d+%d*%d] is not finite!", i, host_nb,
419 xbt_assert(std::isfinite(rate), "rate is not finite!");
421 std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
422 std::vector<double> flops_parallel_amount;
423 std::vector<double> bytes_parallel_amount;
424 if (flops_amount != nullptr)
425 flops_parallel_amount = std::vector<double>(flops_amount, flops_amount + host_nb);
426 if (bytes_amount != nullptr)
427 bytes_parallel_amount = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
428 return simgrid::simix::simcall([name, hosts, flops_parallel_amount, bytes_parallel_amount, timeout] {
429 simgrid::kernel::activity::ExecImpl* exec = new simgrid::kernel::activity::ExecImpl();
433 .set_timeout(timeout)
434 .set_flops_amounts(flops_parallel_amount)
435 .set_bytes_amounts(bytes_parallel_amount)
437 return simgrid::kernel::activity::ExecImplPtr(exec);
442 void SIMIX_comm_finish(smx_activity_t synchro)
444 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();