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-2017. 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. */
13 #include <cmath> /* std::isfinite() */
18 #include "simgrid/s4u/VirtualMachine.hpp"
19 #include "simgrid/simix.hpp"
20 #include "simgrid/simix/blocking_simcall.hpp"
21 #include "smx_private.hpp"
22 #include "src/kernel/activity/CommImpl.hpp"
23 #include "src/mc/mc_forward.hpp"
24 #include "src/mc/mc_replay.hpp"
25 #include "src/plugins/vm/VirtualMachineImpl.hpp"
26 #include "src/simix/smx_host_private.hpp"
28 #include "xbt/functional.hpp"
30 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
32 #include "popping_bodies.cpp"
34 void simcall_call(smx_actor_t actor)
36 if (actor != simix_global->maestro_process) {
37 XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->getCname(), SIMIX_simcall_name(actor->simcall.call),
38 (int)actor->simcall.call);
39 SIMIX_process_yield(actor);
41 SIMIX_simcall_handle(&actor->simcall, 0);
46 * \ingroup simix_process_management
47 * \brief Creates a synchro that executes some computation of an host.
49 * This function creates a SURF action and allocates the data necessary
50 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
52 * \param name Name of the execution synchro to create
53 * \param flops_amount amount Computation amount (in flops)
54 * \param priority computation priority
56 * \return A new SIMIX execution synchronization
58 smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound,
59 simgrid::s4u::Host* host)
61 /* checking for infinite values */
62 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
63 xbt_assert(std::isfinite(priority), "priority is not finite!");
65 return simcall_BODY_execution_start(name, flops_amount, priority, bound, host);
69 * \ingroup simix_process_management
70 * \brief Creates a synchro that may involve parallel computation on
71 * several hosts and communication between them.
73 * \param name Name of the execution synchro to create
74 * \param host_nb Number of hosts where the synchro will be executed
75 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
76 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
77 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
78 * amount between each pair of hosts
79 * \param amount the SURF action amount
80 * \param rate the SURF action rate
81 * \param timeout timeout
82 * \return A new SIMIX execution synchronization
84 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
85 double* flops_amount, double* bytes_amount, double rate, double timeout)
87 /* checking for infinite values */
88 for (int i = 0 ; i < host_nb ; ++i) {
89 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
90 if (bytes_amount != nullptr) {
91 for (int j = 0 ; j < host_nb ; ++j) {
92 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
93 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
98 xbt_assert(std::isfinite(rate), "rate is not finite!");
100 return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
104 * \ingroup simix_process_management
105 * \brief Cancels an execution synchro.
107 * This functions stops the execution. It calls a surf function.
108 * \param execution The execution synchro to cancel
110 void simcall_execution_cancel(smx_activity_t execution)
112 simgrid::kernel::activity::ExecImplPtr exec =
113 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
114 if (not exec->surfAction_)
116 simgrid::simix::kernelImmediate([exec] {
117 XBT_DEBUG("Cancel synchro %p", exec.get());
118 if (exec->surfAction_)
119 exec->surfAction_->cancel();
124 * \ingroup simix_process_management
125 * \brief Changes the priority of an execution synchro.
127 * This functions changes the priority only. It calls a surf function.
128 * \param execution The execution synchro
129 * \param priority The new priority
131 void simcall_execution_set_priority(smx_activity_t execution, double priority)
133 /* checking for infinite values */
134 xbt_assert(std::isfinite(priority), "priority is not finite!");
135 simgrid::simix::kernelImmediate([execution, priority] {
137 simgrid::kernel::activity::ExecImplPtr exec =
138 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
139 if (exec->surfAction_)
140 exec->surfAction_->setSharingWeight(priority);
145 * \ingroup simix_process_management
146 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
148 * This functions changes the capping only. It calls a surf function.
149 * \param execution The execution synchro
150 * \param bound The new bound
152 void simcall_execution_set_bound(smx_activity_t execution, double bound)
154 simgrid::simix::kernelImmediate([execution, bound] {
155 simgrid::kernel::activity::ExecImplPtr exec =
156 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
157 if (exec->surfAction_)
158 exec->surfAction_->setBound(bound);
163 * \ingroup simix_host_management
164 * \brief Waits for the completion of an execution synchro and destroy it.
166 * \param execution The execution synchro
168 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
170 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
173 e_smx_state_t simcall_execution_test(smx_activity_t execution)
175 return (e_smx_state_t)simcall_BODY_execution_test(execution);
179 * \ingroup simix_process_management
180 * \brief Kills all SIMIX processes.
182 void simcall_process_killall(int reset_pid)
184 simcall_BODY_process_killall(reset_pid);
188 * \ingroup simix_process_management
189 * \brief Cleans up a SIMIX process.
190 * \param process poor victim (must have already been killed)
192 void simcall_process_cleanup(smx_actor_t process)
194 simcall_BODY_process_cleanup(process);
197 void simcall_process_join(smx_actor_t process, double timeout)
199 simcall_BODY_process_join(process, timeout);
203 * \ingroup simix_process_management
204 * \brief Suspends a process.
206 * This function suspends the process by suspending the synchro
207 * it was waiting for completion.
209 * \param process a SIMIX process
211 void simcall_process_suspend(smx_actor_t process)
213 simcall_BODY_process_suspend(process);
217 * \ingroup simix_process_management
218 * \brief Returns the amount of SIMIX processes in the system
220 * Maestro internal process is not counted, only user code processes are
222 int simcall_process_count()
224 return simgrid::simix::kernelImmediate(SIMIX_process_count);
228 * \ingroup simix_process_management
229 * \brief Set the user data of a #smx_actor_t.
231 * This functions sets the user data associated to \a process.
232 * \param process SIMIX process
233 * \param data User data
235 void simcall_process_set_data(smx_actor_t process, void *data)
237 simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
241 * \ingroup simix_process_management
242 * \brief Set the kill time of a process.
244 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
247 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
249 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->getCname(), process->host->getCname());
250 process->kill_timer = SIMIX_timer_set(kill_time, [process] {
251 simix_global->kill_process_function(process);
252 process->kill_timer=nullptr;
257 * \ingroup simix_process_management
258 * \brief Add an on_exit function
259 * Add an on_exit function which will be executed when the process exits/is killed.
261 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
263 simcall_BODY_process_on_exit(process, fun, data);
267 * \ingroup simix_process_management
268 * \brief Creates a new sleep SIMIX synchro.
270 * This function creates a SURF action and allocates the data necessary
271 * to create the SIMIX synchro. It can raise a host_error exception if the
272 * host crashed. The default SIMIX name of the synchro is "sleep".
274 * \param duration Time duration of the sleep.
275 * \return A result telling whether the sleep was successful
277 e_smx_state_t simcall_process_sleep(double duration)
279 /* checking for infinite values */
280 xbt_assert(std::isfinite(duration), "duration is not finite!");
281 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
285 * \ingroup simix_comm_management
287 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
288 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
289 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
291 /* checking for infinite values */
292 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
293 xbt_assert(std::isfinite(rate), "rate is not finite!");
294 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
296 xbt_assert(mbox, "No rendez-vous point defined for send");
298 if (MC_is_active() || MC_record_replay_is_active()) {
299 /* the model-checker wants two separate simcalls */
300 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
301 comm = simcall_comm_isend(sender, mbox, task_size, rate,
302 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
303 simcall_comm_wait(comm, timeout);
307 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
308 match_fun, copy_data_fun, data, timeout);
313 * \ingroup simix_comm_management
315 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
316 size_t src_buff_size,
317 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
318 void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
319 void* data, int detached)
321 /* checking for infinite values */
322 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
323 xbt_assert(std::isfinite(rate), "rate is not finite!");
325 xbt_assert(mbox, "No rendez-vous point defined for isend");
327 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
328 src_buff_size, match_fun,
329 clean_fun, copy_data_fun, data, detached);
333 * \ingroup simix_comm_management
335 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
336 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
337 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
339 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
340 xbt_assert(mbox, "No rendez-vous point defined for recv");
342 if (MC_is_active() || MC_record_replay_is_active()) {
343 /* the model-checker wants two separate simcalls */
344 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
345 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
346 match_fun, copy_data_fun, data, rate);
347 simcall_comm_wait(comm, timeout);
351 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
352 match_fun, copy_data_fun, data, timeout, rate);
356 * \ingroup simix_comm_management
358 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
359 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
360 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
362 xbt_assert(mbox, "No rendez-vous point defined for irecv");
364 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
365 match_fun, copy_data_fun, data, rate);
369 * \ingroup simix_comm_management
371 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
372 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
374 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
376 return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
380 * \ingroup simix_comm_management
382 void simcall_comm_cancel(smx_activity_t synchro)
384 simgrid::simix::kernelImmediate([synchro] {
385 simgrid::kernel::activity::CommImplPtr comm =
386 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
392 * \ingroup simix_comm_management
394 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
396 return simcall_BODY_comm_waitany(comms, timeout);
400 * \ingroup simix_comm_management
402 int simcall_comm_testany(smx_activity_t* comms, size_t count)
406 return simcall_BODY_comm_testany(comms, count);
410 * \ingroup simix_comm_management
412 void simcall_comm_wait(smx_activity_t comm, double timeout)
414 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
415 simcall_BODY_comm_wait(comm, timeout);
419 * \brief Set the category of an synchro.
421 * This functions changes the category only. It calls a surf function.
422 * \param synchro The execution synchro
423 * \param category The tracing category
425 void simcall_set_category(smx_activity_t synchro, const char *category)
427 if (category == nullptr) {
430 simcall_BODY_set_category(synchro, category);
434 * \ingroup simix_comm_management
437 int simcall_comm_test(smx_activity_t comm)
439 return simcall_BODY_comm_test(comm);
443 * \ingroup simix_synchro_management
446 smx_mutex_t simcall_mutex_init()
448 if (not simix_global) {
449 fprintf(stderr,"You must run MSG_init before using MSG\n"); // We can't use xbt_die since we may get there before the initialization
452 return simgrid::simix::kernelImmediate([] { return new simgrid::simix::MutexImpl(); });
456 * \ingroup simix_synchro_management
459 void simcall_mutex_lock(smx_mutex_t mutex)
461 simcall_BODY_mutex_lock(mutex);
465 * \ingroup simix_synchro_management
468 int simcall_mutex_trylock(smx_mutex_t mutex)
470 return simcall_BODY_mutex_trylock(mutex);
474 * \ingroup simix_synchro_management
477 void simcall_mutex_unlock(smx_mutex_t mutex)
479 simcall_BODY_mutex_unlock(mutex);
483 * \ingroup simix_synchro_management
486 smx_cond_t simcall_cond_init()
488 return simcall_BODY_cond_init();
492 * \ingroup simix_synchro_management
495 void simcall_cond_signal(smx_cond_t cond)
497 simcall_BODY_cond_signal(cond);
501 * \ingroup simix_synchro_management
504 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
506 simcall_BODY_cond_wait(cond, mutex);
510 * \ingroup simix_synchro_management
513 void simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
515 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
516 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
520 * \ingroup simix_synchro_management
523 void simcall_cond_broadcast(smx_cond_t cond)
525 simcall_BODY_cond_broadcast(cond);
529 * \ingroup simix_synchro_management
532 void simcall_sem_acquire(smx_sem_t sem)
534 simcall_BODY_sem_acquire(sem);
538 * \ingroup simix_synchro_management
541 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
543 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
544 simcall_BODY_sem_acquire_timeout(sem, timeout);
547 sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size)
549 return simcall_BODY_storage_read(st, size);
552 sg_size_t simcall_storage_write(surf_storage_t st, sg_size_t size)
554 return simcall_BODY_storage_write(st, size);
557 void simcall_run_kernel(std::function<void()> const& code)
559 simcall_BODY_run_kernel(&code);
562 void simcall_run_blocking(std::function<void()> const& code)
564 simcall_BODY_run_blocking(&code);
567 int simcall_mc_random(int min, int max) {
568 return simcall_BODY_mc_random(min, max);
571 /* ************************************************************************** */
573 /** @brief returns a printable string representing a simcall */
574 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
575 return simcall_names[kind];
581 void unblock(smx_actor_t process)
583 xbt_assert(SIMIX_is_maestro());
584 SIMIX_simcall_answer(&process->simcall);