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-2015. The SimGrid Team.
9 * All rights reserved. */
11 /* This program is free software; you can redistribute it and/or modify it
12 * under the terms of the license (GNU LGPL) which comes with this package. */
14 #include <cmath> /* std::isfinite() */
19 #include "simgrid/s4u/VirtualMachine.hpp"
20 #include "simgrid/simix.hpp"
21 #include "simgrid/simix/blocking_simcall.hpp"
22 #include "smx_private.h"
23 #include "src/kernel/activity/CommImpl.hpp"
24 #include "src/mc/mc_forward.hpp"
25 #include "src/mc/mc_replay.h"
26 #include "src/plugins/vm/VirtualMachineImpl.hpp"
27 #include "src/simix/smx_host_private.h"
29 #include "xbt/functional.hpp"
31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
33 #include "popping_bodies.cpp"
35 void simcall_call(smx_actor_t actor)
37 if (actor != simix_global->maestro_process) {
38 XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->cname(), SIMIX_simcall_name(actor->simcall.call),
39 (int)actor->simcall.call);
40 SIMIX_process_yield(actor);
42 SIMIX_simcall_handle(&actor->simcall, 0);
47 * \ingroup simix_process_management
48 * \brief Creates a synchro that executes some computation of an host.
50 * This function creates a SURF action and allocates the data necessary
51 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
53 * \param name Name of the execution synchro to create
54 * \param flops_amount amount Computation amount (in flops)
55 * \param priority computation priority
57 * \return A new SIMIX execution synchronization
59 smx_activity_t simcall_execution_start(const char *name,
61 double priority, double bound)
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);
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 amount, double rate,
90 /* checking for infinite values */
91 for (int i = 0 ; i < host_nb ; ++i) {
92 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
93 if (bytes_amount != nullptr) {
94 for (int j = 0 ; j < host_nb ; ++j) {
95 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
96 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
101 xbt_assert(std::isfinite(amount), "amount is not finite!");
102 xbt_assert(std::isfinite(rate), "rate is not finite!");
104 return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
109 * \ingroup simix_process_management
110 * \brief Cancels an execution synchro.
112 * This functions stops the execution. It calls a surf function.
113 * \param execution The execution synchro to cancel
115 void simcall_execution_cancel(smx_activity_t execution)
117 simcall_BODY_execution_cancel(execution);
121 * \ingroup simix_process_management
122 * \brief Changes the priority of an execution synchro.
124 * This functions changes the priority only. It calls a surf function.
125 * \param execution The execution synchro
126 * \param priority The new priority
128 void simcall_execution_set_priority(smx_activity_t execution, double priority)
130 /* checking for infinite values */
131 xbt_assert(std::isfinite(priority), "priority is not finite!");
133 simcall_BODY_execution_set_priority(execution, priority);
137 * \ingroup simix_process_management
138 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
140 * This functions changes the capping only. It calls a surf function.
141 * \param execution The execution synchro
142 * \param bound The new bound
144 void simcall_execution_set_bound(smx_activity_t execution, double bound)
146 simcall_BODY_execution_set_bound(execution, bound);
150 * \ingroup simix_host_management
151 * \brief Waits for the completion of an execution synchro and destroy it.
153 * \param execution The execution synchro
155 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
157 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
161 * \ingroup simix_process_management
162 * \brief Kills a SIMIX process.
164 * This function simply kills a process.
166 * \param process poor victim
168 void simcall_process_kill(smx_actor_t process)
170 simcall_BODY_process_kill(process);
174 * \ingroup simix_process_management
175 * \brief Kills all SIMIX processes.
177 void simcall_process_killall(int reset_pid)
179 simcall_BODY_process_killall(reset_pid);
183 * \ingroup simix_process_management
184 * \brief Cleans up a SIMIX process.
185 * \param process poor victim (must have already been killed)
187 void simcall_process_cleanup(smx_actor_t process)
189 simcall_BODY_process_cleanup(process);
192 void simcall_process_join(smx_actor_t process, double timeout)
194 simcall_BODY_process_join(process, timeout);
198 * \ingroup simix_process_management
199 * \brief Suspends a process.
201 * This function suspends the process by suspending the synchro
202 * it was waiting for completion.
204 * \param process a SIMIX process
206 void simcall_process_suspend(smx_actor_t process)
208 simcall_BODY_process_suspend(process);
212 * \ingroup simix_process_management
213 * \brief Returns the amount of SIMIX processes in the system
215 * Maestro internal process is not counted, only user code processes are
217 int simcall_process_count()
219 return simgrid::simix::kernelImmediate(SIMIX_process_count);
223 * \ingroup simix_process_management
224 * \brief Set the user data of a #smx_actor_t.
226 * This functions sets the user data associated to \a process.
227 * \param process SIMIX process
228 * \param data User data
230 void simcall_process_set_data(smx_actor_t process, void *data)
232 simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
236 * \ingroup simix_process_management
237 * \brief Set the kill time of a process.
239 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
242 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
244 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->getCname());
245 process->kill_timer = SIMIX_timer_set(kill_time, [=] {
246 simix_global->kill_process_function(process);
247 process->kill_timer=nullptr;
252 * \ingroup simix_process_management
253 * \brief Return the properties
255 * This function returns the properties associated with this process
257 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
259 return process->properties;
262 * \ingroup simix_process_management
263 * \brief Add an on_exit function
264 * Add an on_exit function which will be executed when the process exits/is killed.
266 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
268 simcall_BODY_process_on_exit(process, fun, data);
271 * \ingroup simix_process_management
272 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
273 * Will restart the process when the host comes back up if auto_restart is set to 1.
276 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
278 simcall_BODY_process_auto_restart_set(process, auto_restart);
282 * \ingroup simix_process_management
283 * \brief Restarts the process, killing it and starting it again from scratch.
285 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
287 return (smx_actor_t) simcall_BODY_process_restart(process);
290 * \ingroup simix_process_management
291 * \brief Creates a new sleep SIMIX synchro.
293 * This function creates a SURF action and allocates the data necessary
294 * to create the SIMIX synchro. It can raise a host_error exception if the
295 * host crashed. The default SIMIX name of the synchro is "sleep".
297 * \param duration Time duration of the sleep.
298 * \return A result telling whether the sleep was successful
300 e_smx_state_t simcall_process_sleep(double duration)
302 /* checking for infinite values */
303 xbt_assert(std::isfinite(duration), "duration is not finite!");
304 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
308 * \ingroup simix_comm_management
310 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
311 size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
312 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
314 /* checking for infinite values */
315 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
316 xbt_assert(std::isfinite(rate), "rate is not finite!");
317 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
319 xbt_assert(mbox, "No rendez-vous point defined for send");
321 if (MC_is_active() || MC_record_replay_is_active()) {
322 /* the model-checker wants two separate simcalls */
323 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
324 comm = simcall_comm_isend(sender, mbox, task_size, rate,
325 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
326 simcall_comm_wait(comm, timeout);
330 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
331 match_fun, copy_data_fun, data, timeout);
336 * \ingroup simix_comm_management
338 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
339 size_t src_buff_size,
340 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
341 void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
342 void* data, int detached)
344 /* checking for infinite values */
345 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
346 xbt_assert(std::isfinite(rate), "rate is not finite!");
348 xbt_assert(mbox, "No rendez-vous point defined for isend");
350 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
351 src_buff_size, match_fun,
352 clean_fun, copy_data_fun, data, detached);
356 * \ingroup simix_comm_management
358 void simcall_comm_recv(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 timeout, double rate)
362 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
363 xbt_assert(mbox, "No rendez-vous point defined for recv");
365 if (MC_is_active() || MC_record_replay_is_active()) {
366 /* the model-checker wants two separate simcalls */
367 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
368 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
369 match_fun, copy_data_fun, data, rate);
370 simcall_comm_wait(comm, timeout);
374 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
375 match_fun, copy_data_fun, data, timeout, rate);
379 * \ingroup simix_comm_management
381 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
382 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
383 void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
385 xbt_assert(mbox, "No rendez-vous point defined for irecv");
387 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
388 match_fun, copy_data_fun, data, rate);
392 * \ingroup simix_comm_management
394 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
395 int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
397 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
399 return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
403 * \ingroup simix_comm_management
405 void simcall_comm_cancel(smx_activity_t synchro)
407 simgrid::simix::kernelImmediate([synchro] {
408 simgrid::kernel::activity::CommImplPtr comm =
409 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
415 * \ingroup simix_comm_management
417 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
419 return simcall_BODY_comm_waitany(comms, timeout);
423 * \ingroup simix_comm_management
425 int simcall_comm_testany(smx_activity_t* comms, size_t count)
429 return simcall_BODY_comm_testany(comms, count);
433 * \ingroup simix_comm_management
435 void simcall_comm_wait(smx_activity_t comm, double timeout)
437 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
438 simcall_BODY_comm_wait(comm, timeout);
442 * \brief Set the category of an synchro.
444 * This functions changes the category only. It calls a surf function.
445 * \param synchro The execution synchro
446 * \param category The tracing category
448 void simcall_set_category(smx_activity_t synchro, const char *category)
450 if (category == nullptr) {
453 simcall_BODY_set_category(synchro, category);
457 * \ingroup simix_comm_management
460 int simcall_comm_test(smx_activity_t comm)
462 return simcall_BODY_comm_test(comm);
466 * \ingroup simix_synchro_management
469 smx_mutex_t simcall_mutex_init()
471 if (not simix_global) {
472 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
475 return simcall_BODY_mutex_init();
479 * \ingroup simix_synchro_management
482 void simcall_mutex_lock(smx_mutex_t mutex)
484 simcall_BODY_mutex_lock(mutex);
488 * \ingroup simix_synchro_management
491 int simcall_mutex_trylock(smx_mutex_t mutex)
493 return simcall_BODY_mutex_trylock(mutex);
497 * \ingroup simix_synchro_management
500 void simcall_mutex_unlock(smx_mutex_t mutex)
502 simcall_BODY_mutex_unlock(mutex);
506 * \ingroup simix_synchro_management
509 smx_cond_t simcall_cond_init()
511 return simcall_BODY_cond_init();
515 * \ingroup simix_synchro_management
518 void simcall_cond_signal(smx_cond_t cond)
520 simcall_BODY_cond_signal(cond);
524 * \ingroup simix_synchro_management
527 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
529 simcall_BODY_cond_wait(cond, mutex);
533 * \ingroup simix_synchro_management
536 void simcall_cond_wait_timeout(smx_cond_t cond,
540 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
541 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
545 * \ingroup simix_synchro_management
548 void simcall_cond_broadcast(smx_cond_t cond)
550 simcall_BODY_cond_broadcast(cond);
554 * \ingroup simix_synchro_management
557 smx_sem_t simcall_sem_init(int capacity)
559 return simcall_BODY_sem_init(capacity);
563 * \ingroup simix_synchro_management
566 void simcall_sem_release(smx_sem_t sem)
568 simcall_BODY_sem_release(sem);
572 * \ingroup simix_synchro_management
575 int simcall_sem_would_block(smx_sem_t sem)
577 return simcall_BODY_sem_would_block(sem);
581 * \ingroup simix_synchro_management
584 void simcall_sem_acquire(smx_sem_t sem)
586 simcall_BODY_sem_acquire(sem);
590 * \ingroup simix_synchro_management
593 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
595 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
596 simcall_BODY_sem_acquire_timeout(sem, timeout);
600 * \ingroup simix_synchro_management
603 int simcall_sem_get_capacity(smx_sem_t sem)
605 return simcall_BODY_sem_get_capacity(sem);
609 * \ingroup simix_file_management
612 sg_size_t simcall_file_read(surf_file_t fd, sg_size_t size, sg_host_t host)
614 return simcall_BODY_file_read(fd, size, host);
618 * \ingroup simix_file_management
621 sg_size_t simcall_file_write(surf_file_t fd, sg_size_t size, sg_host_t host)
623 return simcall_BODY_file_write(fd, size, host);
627 * \ingroup simix_file_management
630 surf_file_t simcall_file_open(const char* mount, const char* path, sg_storage_t st)
632 return simcall_BODY_file_open(mount, path, st);
636 * \ingroup simix_file_management
639 int simcall_file_close(surf_file_t fd, sg_host_t host)
641 return simcall_BODY_file_close(fd, host);
644 void simcall_run_kernel(std::function<void()> const& code)
646 simcall_BODY_run_kernel(&code);
649 void simcall_run_blocking(std::function<void()> const& code)
651 simcall_BODY_run_blocking(&code);
654 int simcall_mc_random(int min, int max) {
655 return simcall_BODY_mc_random(min, max);
658 /* ************************************************************************** */
660 /** @brief returns a printable string representing a simcall */
661 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
662 return simcall_names[kind];
668 void unblock(smx_actor_t process)
670 xbt_assert(SIMIX_is_maestro());
671 SIMIX_simcall_answer(&process->simcall);