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-2018. 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/kernel/activity/ConditionVariableImpl.hpp"
24 #include "src/kernel/activity/MutexImpl.hpp"
25 #include "src/mc/mc_forward.hpp"
26 #include "src/mc/mc_replay.hpp"
27 #include "src/plugins/vm/VirtualMachineImpl.hpp"
28 #include "src/simix/smx_host_private.hpp"
30 #include "xbt/functional.hpp"
32 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
34 #include "popping_bodies.cpp"
36 void simcall_call(smx_actor_t actor)
38 if (actor != simix_global->maestro_process) {
39 XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->get_cname(), SIMIX_simcall_name(actor->simcall.call),
40 (int)actor->simcall.call);
41 SIMIX_process_yield(actor);
43 SIMIX_simcall_handle(&actor->simcall, 0);
48 * \ingroup simix_process_management
49 * \brief Creates a synchro that executes some computation of an host.
51 * This function creates a SURF action and allocates the data necessary
52 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
54 * \param name Name of the execution synchro to create
55 * \param flops_amount amount Computation amount (in flops)
56 * \param priority computation priority
58 * \return A new SIMIX execution synchronization
60 smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound,
61 simgrid::s4u::Host* host)
63 /* checking for infinite values */
64 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
65 xbt_assert(std::isfinite(priority), "priority is not finite!");
67 return simcall_BODY_execution_start(name, flops_amount, priority, bound, host);
71 * \ingroup simix_process_management
72 * \brief Creates a synchro that may involve parallel computation on
73 * several hosts and communication between them.
75 * \param name Name of the execution synchro to create
76 * \param host_nb Number of hosts where the synchro will be executed
77 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
78 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
79 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
80 * amount between each pair of hosts
81 * \param amount the SURF action amount
82 * \param rate the SURF action rate
83 * \param timeout timeout
84 * \return A new SIMIX execution synchronization
86 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
87 double* flops_amount, double* bytes_amount, double rate, double timeout)
89 /* checking for infinite values */
90 for (int i = 0 ; i < host_nb ; ++i) {
91 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
92 if (bytes_amount != nullptr) {
93 for (int j = 0 ; j < host_nb ; ++j) {
94 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
95 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
100 xbt_assert(std::isfinite(rate), "rate is not finite!");
102 return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
106 * \ingroup simix_process_management
107 * \brief Cancels an execution synchro.
109 * This functions stops the execution. It calls a surf function.
110 * \param execution The execution synchro to cancel
112 void simcall_execution_cancel(smx_activity_t execution)
114 simgrid::kernel::activity::ExecImplPtr exec =
115 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
116 if (not exec->surfAction_)
118 simgrid::simix::kernelImmediate([exec] {
119 XBT_DEBUG("Cancel synchro %p", exec.get());
120 if (exec->surfAction_)
121 exec->surfAction_->cancel();
126 * \ingroup simix_process_management
127 * \brief Changes the priority of an execution synchro.
129 * This functions changes the priority only. It calls a surf function.
130 * \param execution The execution synchro
131 * \param priority The new priority
133 void simcall_execution_set_priority(smx_activity_t execution, double priority)
135 /* checking for infinite values */
136 xbt_assert(std::isfinite(priority), "priority is not finite!");
137 simgrid::simix::kernelImmediate([execution, priority] {
139 simgrid::kernel::activity::ExecImplPtr exec =
140 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
141 if (exec->surfAction_)
142 exec->surfAction_->set_priority(priority);
147 * \ingroup simix_process_management
148 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
150 * This functions changes the capping only. It calls a surf function.
151 * \param execution The execution synchro
152 * \param bound The new bound
154 void simcall_execution_set_bound(smx_activity_t execution, double bound)
156 simgrid::simix::kernelImmediate([execution, bound] {
157 simgrid::kernel::activity::ExecImplPtr exec =
158 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
159 if (exec->surfAction_)
160 exec->surfAction_->set_bound(bound);
165 * \ingroup simix_host_management
166 * \brief Waits for the completion of an execution synchro and destroy it.
168 * \param execution The execution synchro
170 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
172 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
175 e_smx_state_t simcall_execution_test(smx_activity_t execution)
177 return (e_smx_state_t)simcall_BODY_execution_test(execution);
181 * \ingroup simix_process_management
182 * \brief Kills all SIMIX processes.
184 void simcall_process_killall()
186 simcall_BODY_process_killall();
190 * \ingroup simix_process_management
191 * \brief Cleans up a SIMIX process.
192 * \param process poor victim (must have already been killed)
194 void simcall_process_cleanup(smx_actor_t process)
196 simcall_BODY_process_cleanup(process);
199 void simcall_process_join(smx_actor_t process, double timeout)
201 simcall_BODY_process_join(process, timeout);
205 * \ingroup simix_process_management
206 * \brief Suspends a process.
208 * This function suspends the process by suspending the synchro
209 * it was waiting for completion.
211 * \param process a SIMIX process
213 void simcall_process_suspend(smx_actor_t process)
215 simcall_BODY_process_suspend(process);
219 * \ingroup simix_process_management
220 * \brief Returns the amount of SIMIX processes in the system
222 * Maestro internal process is not counted, only user code processes are
224 int simcall_process_count()
226 return simgrid::simix::kernelImmediate(SIMIX_process_count);
230 * \ingroup simix_process_management
231 * \brief Set the user data of a #smx_actor_t.
233 * This functions sets the user data associated to \a process.
234 * \param process SIMIX process
235 * \param data User data
237 void simcall_process_set_data(smx_actor_t process, void *data)
239 simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
243 * \ingroup simix_process_management
244 * \brief Set the kill time of a process.
246 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
249 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
251 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->get_cname(), process->host->get_cname());
252 process->kill_timer = SIMIX_timer_set(kill_time, [process] {
253 simix_global->kill_process_function(process);
254 process->kill_timer=nullptr;
259 * \ingroup simix_process_management
260 * \brief Add an on_exit function
261 * Add an on_exit function which will be executed when the process exits/is killed.
263 XBT_PUBLIC void simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data)
265 simcall_BODY_process_on_exit(process, fun, data);
269 * \ingroup simix_process_management
270 * \brief Creates a new sleep SIMIX synchro.
272 * This function creates a SURF action and allocates the data necessary
273 * to create the SIMIX synchro. It can raise a host_error exception if the
274 * host crashed. The default SIMIX name of the synchro is "sleep".
276 * \param duration Time duration of the sleep.
277 * \return A result telling whether the sleep was successful
279 e_smx_state_t simcall_process_sleep(double duration)
281 /* checking for infinite values */
282 xbt_assert(std::isfinite(duration), "duration is not finite!");
283 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
287 * \ingroup simix_comm_management
289 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
290 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
291 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
293 /* checking for infinite values */
294 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
295 xbt_assert(std::isfinite(rate), "rate is not finite!");
296 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
298 xbt_assert(mbox, "No rendez-vous point defined for send");
300 if (MC_is_active() || MC_record_replay_is_active()) {
301 /* the model-checker wants two separate simcalls */
302 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
303 comm = simcall_comm_isend(sender, mbox, task_size, rate,
304 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
305 simcall_comm_wait(comm, timeout);
309 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
310 match_fun, copy_data_fun, data, timeout);
315 * \ingroup simix_comm_management
317 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
318 size_t src_buff_size,
319 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
320 void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
321 void* data, int detached)
323 /* checking for infinite values */
324 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
325 xbt_assert(std::isfinite(rate), "rate is not finite!");
327 xbt_assert(mbox, "No rendez-vous point defined for isend");
329 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
330 src_buff_size, match_fun,
331 clean_fun, copy_data_fun, data, detached);
335 * \ingroup simix_comm_management
337 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
338 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
339 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
341 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
342 xbt_assert(mbox, "No rendez-vous point defined for recv");
344 if (MC_is_active() || MC_record_replay_is_active()) {
345 /* the model-checker wants two separate simcalls */
346 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
347 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
348 match_fun, copy_data_fun, data, rate);
349 simcall_comm_wait(comm, timeout);
353 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
354 match_fun, copy_data_fun, data, timeout, rate);
358 * \ingroup simix_comm_management
360 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
361 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
362 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
364 xbt_assert(mbox, "No rendez-vous point defined for irecv");
366 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
367 match_fun, copy_data_fun, data, rate);
371 * \ingroup simix_comm_management
373 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
374 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
376 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
378 return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
382 * \ingroup simix_comm_management
384 void simcall_comm_cancel(smx_activity_t synchro)
386 simgrid::simix::kernelImmediate([synchro] {
387 simgrid::kernel::activity::CommImplPtr comm =
388 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
394 * \ingroup simix_comm_management
396 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
398 return simcall_BODY_comm_waitany(comms, timeout);
402 * \ingroup simix_comm_management
404 int simcall_comm_testany(smx_activity_t* comms, size_t count)
408 return simcall_BODY_comm_testany(comms, count);
412 * \ingroup simix_comm_management
414 void simcall_comm_wait(smx_activity_t comm, double timeout)
416 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
417 simcall_BODY_comm_wait(comm, timeout);
421 * \brief Set the category of an synchro.
423 * This functions changes the category only. It calls a surf function.
424 * \param synchro The execution synchro
425 * \param category The tracing category
427 void simcall_set_category(smx_activity_t synchro, const char *category)
429 if (category == nullptr) {
432 simcall_BODY_set_category(synchro, category);
436 * \ingroup simix_comm_management
439 int simcall_comm_test(smx_activity_t comm)
441 return simcall_BODY_comm_test(comm);
445 * \ingroup simix_synchro_management
448 smx_mutex_t simcall_mutex_init()
450 if (not simix_global) {
451 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
454 return simgrid::simix::kernelImmediate([] { return new simgrid::kernel::activity::MutexImpl(); });
458 * \ingroup simix_synchro_management
461 void simcall_mutex_lock(smx_mutex_t mutex)
463 simcall_BODY_mutex_lock(mutex);
467 * \ingroup simix_synchro_management
470 int simcall_mutex_trylock(smx_mutex_t mutex)
472 return simcall_BODY_mutex_trylock(mutex);
476 * \ingroup simix_synchro_management
479 void simcall_mutex_unlock(smx_mutex_t mutex)
481 simcall_BODY_mutex_unlock(mutex);
485 * \ingroup simix_synchro_management
488 smx_cond_t simcall_cond_init()
490 return simcall_BODY_cond_init();
494 * \ingroup simix_synchro_management
497 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
499 simcall_BODY_cond_wait(cond, mutex);
503 * \ingroup simix_synchro_management
506 void simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
508 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
509 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
513 * \ingroup simix_synchro_management
516 void simcall_sem_acquire(smx_sem_t sem)
518 simcall_BODY_sem_acquire(sem);
522 * \ingroup simix_synchro_management
525 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
527 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
528 simcall_BODY_sem_acquire_timeout(sem, timeout);
531 sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size)
533 return simcall_BODY_storage_read(st, size);
536 sg_size_t simcall_storage_write(surf_storage_t st, sg_size_t size)
538 return simcall_BODY_storage_write(st, size);
541 void simcall_run_kernel(std::function<void()> const& code)
543 simcall_BODY_run_kernel(&code);
546 void simcall_run_blocking(std::function<void()> const& code)
548 simcall_BODY_run_blocking(&code);
551 int simcall_mc_random(int min, int max) {
552 return simcall_BODY_mc_random(min, max);
555 /* ************************************************************************** */
557 /** @brief returns a printable string representing a simcall */
558 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
559 return simcall_names[kind];
565 void unblock(smx_actor_t process)
567 xbt_assert(SIMIX_is_maestro());
568 SIMIX_simcall_answer(&process->simcall);