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() */
18 #include <xbt/functional.hpp>
20 #include <simgrid/s4u/VirtualMachine.hpp>
21 #include <simgrid/simix/blocking_simcall.hpp>
24 #include "smx_private.h"
25 #include "src/kernel/activity/SynchroComm.hpp"
26 #include "src/mc/mc_forward.hpp"
27 #include "src/mc/mc_replay.h"
28 #include "src/plugins/vm/VirtualMachineImpl.hpp"
29 #include "src/simix/smx_host_private.h"
32 #include <simgrid/simix.hpp>
34 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
36 #include "popping_bodies.cpp"
38 void simcall_call(smx_actor_t process)
40 if (process != simix_global->maestro_process) {
41 XBT_DEBUG("Yield process '%s' on simcall %s (%d)", process->name.c_str(),
42 SIMIX_simcall_name(process->simcall.call), (int)process->simcall.call);
43 SIMIX_process_yield(process);
45 SIMIX_simcall_handle(&process->simcall, 0);
50 * \ingroup simix_process_management
51 * \brief Creates a synchro that executes some computation of an host.
53 * This function creates a SURF action and allocates the data necessary
54 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
56 * \param name Name of the execution synchro to create
57 * \param flops_amount amount Computation amount (in flops)
58 * \param priority computation priority
60 * \return A new SIMIX execution synchronization
62 smx_activity_t simcall_execution_start(const char *name,
64 double priority, double bound)
66 /* checking for infinite values */
67 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
68 xbt_assert(std::isfinite(priority), "priority is not finite!");
70 return simcall_BODY_execution_start(name, flops_amount, priority, bound);
74 * \ingroup simix_process_management
75 * \brief Creates a synchro that may involve parallel computation on
76 * several hosts and communication between them.
78 * \param name Name of the execution synchro to create
79 * \param host_nb Number of hosts where the synchro will be executed
80 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
81 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
82 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
83 * amount between each pair of hosts
84 * \param amount the SURF action amount
85 * \param rate the SURF action rate
86 * \param timeout timeout
87 * \return A new SIMIX execution synchronization
89 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
90 double* flops_amount, double* bytes_amount, double amount, double rate,
94 /* checking for infinite values */
95 for (i = 0 ; i < host_nb ; ++i) {
96 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
97 if (bytes_amount != nullptr) {
98 for (j = 0 ; j < host_nb ; ++j) {
99 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
100 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
105 xbt_assert(std::isfinite(amount), "amount is not finite!");
106 xbt_assert(std::isfinite(rate), "rate is not finite!");
108 return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
113 * \ingroup simix_process_management
114 * \brief Cancels an execution synchro.
116 * This functions stops the execution. It calls a surf function.
117 * \param execution The execution synchro to cancel
119 void simcall_execution_cancel(smx_activity_t execution)
121 simcall_BODY_execution_cancel(execution);
125 * \ingroup simix_process_management
126 * \brief Changes the priority of an execution synchro.
128 * This functions changes the priority only. It calls a surf function.
129 * \param execution The execution synchro
130 * \param priority The new priority
132 void simcall_execution_set_priority(smx_activity_t execution, double priority)
134 /* checking for infinite values */
135 xbt_assert(std::isfinite(priority), "priority is not finite!");
137 simcall_BODY_execution_set_priority(execution, priority);
141 * \ingroup simix_process_management
142 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
144 * This functions changes the capping only. It calls a surf function.
145 * \param execution The execution synchro
146 * \param bound The new bound
148 void simcall_execution_set_bound(smx_activity_t execution, double bound)
150 simcall_BODY_execution_set_bound(execution, bound);
154 * \ingroup simix_host_management
155 * \brief Waits for the completion of an execution synchro and destroy it.
157 * \param execution The execution synchro
159 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
161 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
165 * \ingroup simix_vm_management
166 * \brief Suspend the given VM
170 void simcall_vm_suspend(sg_host_t vm)
172 simcall_BODY_vm_suspend(vm);
176 * \ingroup simix_vm_management
177 * \brief Shutdown the given VM
181 void simcall_vm_shutdown(sg_host_t vm)
183 simcall_BODY_vm_shutdown(vm);
187 * \ingroup simix_process_management
188 * \brief Kills a SIMIX process.
190 * This function simply kills a process.
192 * \param process poor victim
194 void simcall_process_kill(smx_actor_t process)
196 simcall_BODY_process_kill(process);
200 * \ingroup simix_process_management
201 * \brief Kills all SIMIX processes.
203 void simcall_process_killall(int reset_pid)
205 simcall_BODY_process_killall(reset_pid);
209 * \ingroup simix_process_management
210 * \brief Cleans up a SIMIX process.
211 * \param process poor victim (must have already been killed)
213 void simcall_process_cleanup(smx_actor_t process)
215 simcall_BODY_process_cleanup(process);
219 * \ingroup simix_process_management
220 * \brief Migrates an agent to another location.
222 * This function changes the value of the host on which \a process is running.
224 * \param process the process to migrate
225 * \param dest name of the new host
227 void simcall_process_set_host(smx_actor_t process, sg_host_t dest)
229 simcall_BODY_process_set_host(process, dest);
232 void simcall_process_join(smx_actor_t process, double timeout)
234 simcall_BODY_process_join(process, timeout);
238 * \ingroup simix_process_management
239 * \brief Suspends a process.
241 * This function suspends the process by suspending the synchro
242 * it was waiting for completion.
244 * \param process a SIMIX process
246 void simcall_process_suspend(smx_actor_t process)
248 simcall_BODY_process_suspend(process);
252 * \ingroup simix_process_management
253 * \brief Resumes a suspended process.
255 * This function resumes a suspended process by resuming the synchro
256 * it was waiting for completion.
258 * \param process a SIMIX process
260 void simcall_process_resume(smx_actor_t process)
262 simcall_BODY_process_resume(process);
266 * \ingroup simix_process_management
267 * \brief Returns the amount of SIMIX processes in the system
269 * Maestro internal process is not counted, only user code processes are
271 int simcall_process_count()
273 return simgrid::simix::kernelImmediate(SIMIX_process_count);
277 * \ingroup simix_process_management
278 * \brief Return the user data of a #smx_actor_t.
279 * \param process a SIMIX process
280 * \return the user data of this process
282 void* simcall_process_get_data(smx_actor_t process)
284 return SIMIX_process_get_data(process);
288 * \ingroup simix_process_management
289 * \brief Set the user data of a #smx_actor_t.
291 * This functions sets the user data associated to \a process.
292 * \param process SIMIX process
293 * \param data User data
295 void simcall_process_set_data(smx_actor_t process, void *data)
297 simgrid::simix::kernelImmediate(std::bind(SIMIX_process_set_data, process, data));
301 * \ingroup simix_process_management
302 * \brief Set the kill time of a process.
304 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
307 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
309 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->cname());
310 process->kill_timer = SIMIX_timer_set(kill_time, [=] {
311 simix_global->kill_process_function(process);
312 process->kill_timer=nullptr;
316 * \ingroup simix_process_management
317 * \brief Get the kill time of a process (or 0 if unset).
319 double simcall_process_get_kill_time(smx_actor_t process) {
320 return SIMIX_timer_get_date(process->kill_timer);
324 * \ingroup simix_process_management
325 * \brief Returns true if the process is suspended .
327 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
328 * \param process SIMIX process
329 * \return 1, if the process is suspended, else 0.
331 int simcall_process_is_suspended(smx_actor_t process)
333 return simcall_BODY_process_is_suspended(process);
337 * \ingroup simix_process_management
338 * \brief Return the properties
340 * This functions returns the properties associated with this process
342 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
344 return SIMIX_process_get_properties(process);
347 * \ingroup simix_process_management
348 * \brief Add an on_exit function
349 * Add an on_exit function which will be executed when the process exits/is killed.
351 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
353 simcall_BODY_process_on_exit(process, fun, data);
356 * \ingroup simix_process_management
357 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
358 * Will restart the process when the host comes back up if auto_restart is set to 1.
361 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
363 simcall_BODY_process_auto_restart_set(process, auto_restart);
367 * \ingroup simix_process_management
368 * \brief Restarts the process, killing it and starting it again from scratch.
370 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
372 return (smx_actor_t) simcall_BODY_process_restart(process);
375 * \ingroup simix_process_management
376 * \brief Creates a new sleep SIMIX synchro.
378 * This function creates a SURF action and allocates the data necessary
379 * to create the SIMIX synchro. It can raise a host_error exception if the
380 * host crashed. The default SIMIX name of the synchro is "sleep".
382 * \param duration Time duration of the sleep.
383 * \return A result telling whether the sleep was successful
385 e_smx_state_t simcall_process_sleep(double duration)
387 /* checking for infinite values */
388 xbt_assert(std::isfinite(duration), "duration is not finite!");
389 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
393 * \ingroup simix_mbox_management
394 * \brief Creates a new rendez-vous point
395 * \param name The name of the rendez-vous point
396 * \return The created rendez-vous point
398 smx_mailbox_t simcall_mbox_create(const char *name)
400 return simcall_BODY_mbox_create(name);
403 void simcall_mbox_set_receiver(smx_mailbox_t mbox, smx_actor_t process)
405 simcall_BODY_mbox_set_receiver(mbox, process);
409 * \ingroup simix_comm_management
411 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
412 void *src_buff, size_t src_buff_size,
413 int (*match_fun)(void *, void *, smx_activity_t),
414 void (*copy_data_fun)(smx_activity_t, void*, size_t), void *data,
417 /* checking for infinite values */
418 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
419 xbt_assert(std::isfinite(rate), "rate is not finite!");
420 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
422 xbt_assert(mbox, "No rendez-vous point defined for send");
424 if (MC_is_active() || MC_record_replay_is_active()) {
425 /* the model-checker wants two separate simcalls */
426 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
427 comm = simcall_comm_isend(sender, mbox, task_size, rate,
428 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
429 simcall_comm_wait(comm, timeout);
433 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
434 match_fun, copy_data_fun, data, timeout);
439 * \ingroup simix_comm_management
441 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
442 void *src_buff, size_t src_buff_size,
443 int (*match_fun)(void *, void *, smx_activity_t),
444 void (*clean_fun)(void *),
445 void (*copy_data_fun)(smx_activity_t, void*, size_t),
449 /* checking for infinite values */
450 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
451 xbt_assert(std::isfinite(rate), "rate is not finite!");
453 xbt_assert(mbox, "No rendez-vous point defined for isend");
455 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
456 src_buff_size, match_fun,
457 clean_fun, copy_data_fun, data, detached);
461 * \ingroup simix_comm_management
463 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t * dst_buff_size,
464 int (*match_fun)(void *, void *, smx_activity_t),
465 void (*copy_data_fun)(smx_activity_t, void*, size_t),
466 void *data, double timeout, double rate)
468 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
469 xbt_assert(mbox, "No rendez-vous point defined for recv");
471 if (MC_is_active() || MC_record_replay_is_active()) {
472 /* the model-checker wants two separate simcalls */
473 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
474 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
475 match_fun, copy_data_fun, data, rate);
476 simcall_comm_wait(comm, timeout);
480 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
481 match_fun, copy_data_fun, data, timeout, rate);
485 * \ingroup simix_comm_management
487 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t *dst_buff_size,
488 int (*match_fun)(void *, void *, smx_activity_t),
489 void (*copy_data_fun)(smx_activity_t, void*, size_t),
490 void *data, double rate)
492 xbt_assert(mbox, "No rendez-vous point defined for irecv");
494 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
495 match_fun, copy_data_fun, data, rate);
499 * \ingroup simix_comm_management
501 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
502 int (*match_fun)(void *, void *, smx_activity_t), void *data)
504 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
506 return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
510 * \ingroup simix_comm_management
512 void simcall_comm_cancel(smx_activity_t synchro)
514 simgrid::simix::kernelImmediate([synchro]{
515 simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
521 * \ingroup simix_comm_management
523 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
525 return simcall_BODY_comm_waitany(comms, timeout);
529 * \ingroup simix_comm_management
531 int simcall_comm_testany(smx_activity_t* comms, size_t count)
535 return simcall_BODY_comm_testany(comms, count);
539 * \ingroup simix_comm_management
541 void simcall_comm_wait(smx_activity_t comm, double timeout)
543 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
544 simcall_BODY_comm_wait(comm, timeout);
548 * \brief Set the category of an synchro.
550 * This functions changes the category only. It calls a surf function.
551 * \param execution The execution synchro
552 * \param category The tracing category
554 void simcall_set_category(smx_activity_t synchro, const char *category)
556 if (category == nullptr) {
559 simcall_BODY_set_category(synchro, category);
563 * \ingroup simix_comm_management
566 int simcall_comm_test(smx_activity_t comm)
568 return simcall_BODY_comm_test(comm);
572 * \ingroup simix_synchro_management
575 smx_mutex_t simcall_mutex_init()
578 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
581 return simcall_BODY_mutex_init();
585 * \ingroup simix_synchro_management
588 void simcall_mutex_lock(smx_mutex_t mutex)
590 simcall_BODY_mutex_lock(mutex);
594 * \ingroup simix_synchro_management
597 int simcall_mutex_trylock(smx_mutex_t mutex)
599 return simcall_BODY_mutex_trylock(mutex);
603 * \ingroup simix_synchro_management
606 void simcall_mutex_unlock(smx_mutex_t mutex)
608 simcall_BODY_mutex_unlock(mutex);
612 * \ingroup simix_synchro_management
615 smx_cond_t simcall_cond_init()
617 return simcall_BODY_cond_init();
621 * \ingroup simix_synchro_management
624 void simcall_cond_signal(smx_cond_t cond)
626 simcall_BODY_cond_signal(cond);
630 * \ingroup simix_synchro_management
633 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
635 simcall_BODY_cond_wait(cond, mutex);
639 * \ingroup simix_synchro_management
642 void simcall_cond_wait_timeout(smx_cond_t cond,
646 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
647 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
651 * \ingroup simix_synchro_management
654 void simcall_cond_broadcast(smx_cond_t cond)
656 simcall_BODY_cond_broadcast(cond);
660 * \ingroup simix_synchro_management
663 smx_sem_t simcall_sem_init(int capacity)
665 return simcall_BODY_sem_init(capacity);
669 * \ingroup simix_synchro_management
672 void simcall_sem_release(smx_sem_t sem)
674 simcall_BODY_sem_release(sem);
678 * \ingroup simix_synchro_management
681 int simcall_sem_would_block(smx_sem_t sem)
683 return simcall_BODY_sem_would_block(sem);
687 * \ingroup simix_synchro_management
690 void simcall_sem_acquire(smx_sem_t sem)
692 simcall_BODY_sem_acquire(sem);
696 * \ingroup simix_synchro_management
699 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
701 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
702 simcall_BODY_sem_acquire_timeout(sem, timeout);
706 * \ingroup simix_synchro_management
709 int simcall_sem_get_capacity(smx_sem_t sem)
711 return simcall_BODY_sem_get_capacity(sem);
715 * \ingroup simix_file_management
718 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
720 return simcall_BODY_file_read(fd, size, host);
724 * \ingroup simix_file_management
727 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
729 return simcall_BODY_file_write(fd, size, host);
733 * \ingroup simix_file_management
736 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
738 return simcall_BODY_file_open(fullpath, host);
742 * \ingroup simix_file_management
745 int simcall_file_close(smx_file_t fd, sg_host_t host)
747 return simcall_BODY_file_close(fd, host);
751 * \ingroup simix_file_management
754 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
756 return simcall_BODY_file_unlink(fd, host);
760 * \ingroup simix_file_management
763 sg_size_t simcall_file_get_size(smx_file_t fd){
764 return simcall_BODY_file_get_size(fd);
768 * \ingroup simix_file_management
771 sg_size_t simcall_file_tell(smx_file_t fd){
772 return simcall_BODY_file_tell(fd);
776 * \ingroup simix_file_management
779 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
781 return simcall_BODY_file_get_info(fd);
785 * \ingroup simix_file_management
788 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
789 return simcall_BODY_file_seek(fd, offset, origin);
793 * \ingroup simix_file_management
794 * \brief Move a file to another location on the *same mount point*.
797 int simcall_file_move(smx_file_t fd, const char* fullpath)
799 return simcall_BODY_file_move(fd, fullpath);
803 * \ingroup simix_storage_management
804 * \brief Returns the free space size on a given storage element.
805 * \param storage a storage
806 * \return Return the free space size on a given storage element (as sg_size_t)
808 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
809 return simcall_BODY_storage_get_free_size(storage);
813 * \ingroup simix_storage_management
814 * \brief Returns the used space size on a given storage element.
815 * \param storage a storage
816 * \return Return the used space size on a given storage element (as sg_size_t)
818 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
819 return simcall_BODY_storage_get_used_size(storage);
823 * \ingroup simix_storage_management
824 * \brief Returns a dict of the properties assigned to a storage element.
826 * \param storage A storage element
827 * \return The properties of this storage element
829 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
831 return simcall_BODY_storage_get_properties(storage);
835 * \ingroup simix_storage_management
836 * \brief Returns a dict containing the content of a storage element.
838 * \param storage A storage element
839 * \return The content of this storage element as a dict (full path file => size)
841 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
843 return simcall_BODY_storage_get_content(storage);
846 void simcall_run_kernel(std::function<void()> const& code)
848 simcall_BODY_run_kernel(&code);
851 void simcall_run_blocking(std::function<void()> const& code)
853 simcall_BODY_run_blocking(&code);
856 int simcall_mc_random(int min, int max) {
857 return simcall_BODY_mc_random(min, max);
860 /* ************************************************************************** */
862 /** @brief returns a printable string representing a simcall */
863 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
864 return simcall_names[kind];
870 void unblock(smx_actor_t process)
872 xbt_assert(SIMIX_is_maestro());
873 SIMIX_simcall_answer(&process->simcall);