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"
24 #include "src/simix/smx_io_private.hpp"
26 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
28 #include "popping_bodies.cpp"
31 * @ingroup simix_process_management
32 * @brief Creates a synchro that may involve parallel computation on
33 * several hosts and communication between them.
35 * @param name Name of the execution synchro to create
36 * @param host_nb Number of hosts where the synchro will be executed
37 * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
38 * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
39 * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
40 * amount between each pair of hosts
41 * @param rate the SURF action rate
42 * @param timeout timeout
43 * @return A new SIMIX execution synchronization
45 smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
46 const double* flops_amount, const double* bytes_amount, double rate,
49 /* checking for infinite values */
50 for (int i = 0 ; i < host_nb ; ++i) {
51 if (flops_amount != nullptr)
52 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
53 if (bytes_amount != nullptr) {
54 for (int j = 0 ; j < host_nb ; ++j) {
55 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
56 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
61 xbt_assert(std::isfinite(rate), "rate is not finite!");
63 return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
64 return SIMIX_execution_parallel_start(std::move(name), host_nb, host_list, flops_amount, bytes_amount, rate,
70 * @ingroup simix_host_management
71 * @brief Waits for the completion of an execution synchro and destroy it.
73 * @param execution The execution synchro
75 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
77 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
80 e_smx_state_t simcall_execution_test(smx_activity_t execution)
82 return (e_smx_state_t)simcall_BODY_execution_test(execution);
85 void simcall_process_join(smx_actor_t process, double timeout)
87 simcall_BODY_process_join(process, timeout);
91 * @ingroup simix_process_management
92 * @brief Suspends an actor
94 void simcall_process_suspend(smx_actor_t process)
96 simcall_BODY_process_suspend(process);
100 * @ingroup simix_process_management
101 * @brief Creates a new sleep SIMIX synchro.
103 * This function creates a SURF action and allocates the data necessary
104 * to create the SIMIX synchro. It can raise a HostFailureException if the
105 * host crashed. The default SIMIX name of the synchro is "sleep".
107 * @param duration Time duration of the sleep.
108 * @return A result telling whether the sleep was successful
110 e_smx_state_t simcall_process_sleep(double duration)
112 /* checking for infinite values */
113 xbt_assert(std::isfinite(duration), "duration is not finite!");
114 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
118 * @ingroup simix_comm_management
120 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
121 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
122 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
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*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
152 void* data, int detached)
154 /* checking for infinite values */
155 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
156 xbt_assert(std::isfinite(rate), "rate is not finite!");
158 xbt_assert(mbox, "No rendez-vous point defined for isend");
160 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
161 src_buff_size, match_fun,
162 clean_fun, copy_data_fun, data, detached);
166 * @ingroup simix_comm_management
168 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
169 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
170 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
172 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
173 xbt_assert(mbox, "No rendez-vous point defined for recv");
175 if (MC_is_active() || MC_record_replay_is_active()) {
176 /* the model-checker wants two separate simcalls */
177 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
178 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
179 match_fun, copy_data_fun, data, rate);
180 simcall_comm_wait(comm, timeout);
184 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
185 match_fun, copy_data_fun, data, timeout, rate);
189 * @ingroup simix_comm_management
191 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
192 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
193 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
195 xbt_assert(mbox, "No rendez-vous point defined for irecv");
197 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
198 match_fun, copy_data_fun, data, rate);
202 * @ingroup simix_comm_management
204 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
205 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
207 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
209 return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
213 * @ingroup simix_comm_management
215 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
217 return simcall_BODY_comm_waitany(comms, timeout);
221 * @ingroup simix_comm_management
223 int simcall_comm_testany(smx_activity_t* comms, size_t count)
227 return simcall_BODY_comm_testany(comms, count);
231 * @ingroup simix_comm_management
233 void simcall_comm_wait(smx_activity_t comm, double timeout)
235 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
236 simcall_BODY_comm_wait(comm, timeout);
240 * @ingroup simix_comm_management
243 int simcall_comm_test(smx_activity_t comm)
245 return simcall_BODY_comm_test(comm);
249 * @ingroup simix_synchro_management
252 smx_mutex_t simcall_mutex_init()
254 if (simix_global == nullptr) {
255 fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
256 // get there before the initialization
259 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
263 * @ingroup simix_synchro_management
266 void simcall_mutex_lock(smx_mutex_t mutex)
268 simcall_BODY_mutex_lock(mutex);
272 * @ingroup simix_synchro_management
275 int simcall_mutex_trylock(smx_mutex_t mutex)
277 return simcall_BODY_mutex_trylock(mutex);
281 * @ingroup simix_synchro_management
284 void simcall_mutex_unlock(smx_mutex_t mutex)
286 simcall_BODY_mutex_unlock(mutex);
290 * @ingroup simix_synchro_management
293 smx_cond_t simcall_cond_init()
295 return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
299 * @ingroup simix_synchro_management
302 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
304 simcall_BODY_cond_wait(cond, mutex);
308 * @ingroup simix_synchro_management
311 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
313 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
314 return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
318 * @ingroup simix_synchro_management
321 void simcall_sem_acquire(smx_sem_t sem)
323 simcall_BODY_sem_acquire(sem);
327 * @ingroup simix_synchro_management
330 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
332 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
333 return simcall_BODY_sem_acquire_timeout(sem, timeout);
336 e_smx_state_t simcall_io_wait(smx_activity_t io)
338 return (e_smx_state_t)simcall_BODY_io_wait(io);
341 void simcall_run_kernel(std::function<void()> const& code)
343 simcall_BODY_run_kernel(&code);
346 void simcall_run_blocking(std::function<void()> const& code)
348 simcall_BODY_run_blocking(&code);
351 int simcall_mc_random(int min, int max) {
352 return simcall_BODY_mc_random(min, max);
355 /* ************************************************************************** */
357 /** @brief returns a printable string representing a simcall */
358 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
359 return simcall_names[kind];
365 void unblock(smx_actor_t process)
367 xbt_assert(SIMIX_is_maestro());
368 SIMIX_simcall_answer(&process->simcall);
371 } // namespace simgrid
373 /* ****************************DEPRECATED CALLS******************************* */
374 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
376 simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
378 void simcall_comm_cancel(smx_activity_t comm)
380 simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
382 void simcall_execution_cancel(smx_activity_t exec)
384 simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
386 void simcall_execution_set_priority(smx_activity_t exec, double priority)
388 simgrid::simix::simcall([exec, priority] {
389 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_priority(priority);
393 void simcall_execution_set_bound(smx_activity_t exec, double bound)
395 simgrid::simix::simcall(
396 [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
399 smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
400 double priority, double bound, sg_host_t host)
402 return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
403 return simgrid::kernel::activity::ExecImplPtr(
404 new simgrid::kernel::activity::ExecImpl(std::move(name), std::move(category), nullptr, host))
405 ->start(flops_amount, priority, bound);