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);
52 * \ingroup simix_host_management
53 * \brief Returns a dict of the properties assigned to a router or AS.
55 * \param name The name of the router or AS
56 * \return The properties
58 xbt_dict_t simcall_asr_get_properties(const char *name)
60 return simcall_BODY_asr_get_properties(name);
64 * \ingroup simix_process_management
65 * \brief Creates a synchro that executes some computation of an host.
67 * This function creates a SURF action and allocates the data necessary
68 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
70 * \param name Name of the execution synchro to create
71 * \param flops_amount amount Computation amount (in flops)
72 * \param priority computation priority
74 * \return A new SIMIX execution synchronization
76 smx_activity_t simcall_execution_start(const char *name,
78 double priority, double bound)
80 /* checking for infinite values */
81 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
82 xbt_assert(std::isfinite(priority), "priority is not finite!");
84 return simcall_BODY_execution_start(name, flops_amount, priority, bound);
88 * \ingroup simix_process_management
89 * \brief Creates a synchro that may involve parallel computation on
90 * several hosts and communication between them.
92 * \param name Name of the execution synchro to create
93 * \param host_nb Number of hosts where the synchro will be executed
94 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
95 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
96 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
97 * amount between each pair of hosts
98 * \param amount the SURF action amount
99 * \param rate the SURF action rate
100 * \param timeout timeout
101 * \return A new SIMIX execution synchronization
103 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
104 double* flops_amount, double* bytes_amount, double amount, double rate,
108 /* checking for infinite values */
109 for (i = 0 ; i < host_nb ; ++i) {
110 xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
111 if (bytes_amount != nullptr) {
112 for (j = 0 ; j < host_nb ; ++j) {
113 xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
114 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
119 xbt_assert(std::isfinite(amount), "amount is not finite!");
120 xbt_assert(std::isfinite(rate), "rate is not finite!");
122 return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
127 * \ingroup simix_process_management
128 * \brief Cancels an execution synchro.
130 * This functions stops the execution. It calls a surf function.
131 * \param execution The execution synchro to cancel
133 void simcall_execution_cancel(smx_activity_t execution)
135 simcall_BODY_execution_cancel(execution);
139 * \ingroup simix_process_management
140 * \brief Changes the priority of an execution synchro.
142 * This functions changes the priority only. It calls a surf function.
143 * \param execution The execution synchro
144 * \param priority The new priority
146 void simcall_execution_set_priority(smx_activity_t execution, double priority)
148 /* checking for infinite values */
149 xbt_assert(std::isfinite(priority), "priority is not finite!");
151 simcall_BODY_execution_set_priority(execution, priority);
155 * \ingroup simix_process_management
156 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
158 * This functions changes the capping only. It calls a surf function.
159 * \param execution The execution synchro
160 * \param bound The new bound
162 void simcall_execution_set_bound(smx_activity_t execution, double bound)
164 simcall_BODY_execution_set_bound(execution, bound);
168 * \ingroup simix_host_management
169 * \brief Waits for the completion of an execution synchro and destroy it.
171 * \param execution The execution synchro
173 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
175 return (e_smx_state_t) simcall_BODY_execution_wait(execution);
179 * \ingroup simix_vm_management
180 * \brief Suspend the given VM
184 void simcall_vm_suspend(sg_host_t vm)
186 simcall_BODY_vm_suspend(vm);
190 * \ingroup simix_vm_management
191 * \brief Resume the given VM
195 void simcall_vm_resume(sg_host_t vm)
197 simcall_BODY_vm_resume(vm);
201 * \ingroup simix_vm_management
202 * \brief Save the given VM
206 void simcall_vm_save(sg_host_t vm)
208 simcall_BODY_vm_save(vm);
212 * \ingroup simix_vm_management
213 * \brief Shutdown the given VM
217 void simcall_vm_shutdown(sg_host_t vm)
219 simcall_BODY_vm_shutdown(vm);
223 * \ingroup simix_process_management
224 * \brief Kills a SIMIX process.
226 * This function simply kills a process.
228 * \param process poor victim
230 void simcall_process_kill(smx_actor_t process)
232 simcall_BODY_process_kill(process);
236 * \ingroup simix_process_management
237 * \brief Kills all SIMIX processes.
239 void simcall_process_killall(int reset_pid)
241 simcall_BODY_process_killall(reset_pid);
245 * \ingroup simix_process_management
246 * \brief Cleans up a SIMIX process.
247 * \param process poor victim (must have already been killed)
249 void simcall_process_cleanup(smx_actor_t process)
251 simcall_BODY_process_cleanup(process);
255 * \ingroup simix_process_management
256 * \brief Migrates an agent to another location.
258 * This function changes the value of the host on which \a process is running.
260 * \param process the process to migrate
261 * \param dest name of the new host
263 void simcall_process_set_host(smx_actor_t process, sg_host_t dest)
265 simcall_BODY_process_set_host(process, dest);
268 void simcall_process_join(smx_actor_t process, double timeout)
270 simcall_BODY_process_join(process, timeout);
274 * \ingroup simix_process_management
275 * \brief Suspends a process.
277 * This function suspends the process by suspending the synchro
278 * it was waiting for completion.
280 * \param process a SIMIX process
282 void simcall_process_suspend(smx_actor_t process)
284 simcall_BODY_process_suspend(process);
288 * \ingroup simix_process_management
289 * \brief Resumes a suspended process.
291 * This function resumes a suspended process by resuming the synchro
292 * it was waiting for completion.
294 * \param process a SIMIX process
296 void simcall_process_resume(smx_actor_t process)
298 simcall_BODY_process_resume(process);
302 * \ingroup simix_process_management
303 * \brief Returns the amount of SIMIX processes in the system
305 * Maestro internal process is not counted, only user code processes are
307 int simcall_process_count()
309 return simgrid::simix::kernelImmediate(SIMIX_process_count);
313 * \ingroup simix_process_management
314 * \brief Return the user data of a #smx_actor_t.
315 * \param process a SIMIX process
316 * \return the user data of this process
318 void* simcall_process_get_data(smx_actor_t process)
320 return SIMIX_process_get_data(process);
324 * \ingroup simix_process_management
325 * \brief Set the user data of a #smx_actor_t.
327 * This functions sets the user data associated to \a process.
328 * \param process SIMIX process
329 * \param data User data
331 void simcall_process_set_data(smx_actor_t process, void *data)
333 simgrid::simix::kernelImmediate(std::bind(SIMIX_process_set_data, process, data));
337 * \ingroup simix_process_management
338 * \brief Set the kill time of a process.
340 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
343 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
345 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->cname());
346 process->kill_timer = SIMIX_timer_set(kill_time, [=] {
347 simix_global->kill_process_function(process);
348 process->kill_timer=nullptr;
352 * \ingroup simix_process_management
353 * \brief Get the kill time of a process (or 0 if unset).
355 double simcall_process_get_kill_time(smx_actor_t process) {
356 return SIMIX_timer_get_date(process->kill_timer);
360 * \ingroup simix_process_management
361 * \brief Returns true if the process is suspended .
363 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
364 * \param process SIMIX process
365 * \return 1, if the process is suspended, else 0.
367 int simcall_process_is_suspended(smx_actor_t process)
369 return simcall_BODY_process_is_suspended(process);
373 * \ingroup simix_process_management
374 * \brief Return the properties
376 * This functions returns the properties associated with this process
378 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
380 return SIMIX_process_get_properties(process);
383 * \ingroup simix_process_management
384 * \brief Add an on_exit function
385 * Add an on_exit function which will be executed when the process exits/is killed.
387 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
389 simcall_BODY_process_on_exit(process, fun, data);
392 * \ingroup simix_process_management
393 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
394 * Will restart the process when the host comes back up if auto_restart is set to 1.
397 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
399 simcall_BODY_process_auto_restart_set(process, auto_restart);
403 * \ingroup simix_process_management
404 * \brief Restarts the process, killing it and starting it again from scratch.
406 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
408 return (smx_actor_t) simcall_BODY_process_restart(process);
411 * \ingroup simix_process_management
412 * \brief Creates a new sleep SIMIX synchro.
414 * This function creates a SURF action and allocates the data necessary
415 * to create the SIMIX synchro. It can raise a host_error exception if the
416 * host crashed. The default SIMIX name of the synchro is "sleep".
418 * \param duration Time duration of the sleep.
419 * \return A result telling whether the sleep was successful
421 e_smx_state_t simcall_process_sleep(double duration)
423 /* checking for infinite values */
424 xbt_assert(std::isfinite(duration), "duration is not finite!");
425 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
429 * \ingroup simix_mbox_management
430 * \brief Creates a new rendez-vous point
431 * \param name The name of the rendez-vous point
432 * \return The created rendez-vous point
434 smx_mailbox_t simcall_mbox_create(const char *name)
436 return simcall_BODY_mbox_create(name);
439 void simcall_mbox_set_receiver(smx_mailbox_t mbox, smx_actor_t process)
441 simcall_BODY_mbox_set_receiver(mbox, process);
445 * \ingroup simix_comm_management
447 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
448 void *src_buff, size_t src_buff_size,
449 int (*match_fun)(void *, void *, smx_activity_t),
450 void (*copy_data_fun)(smx_activity_t, void*, size_t), void *data,
453 /* checking for infinite values */
454 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
455 xbt_assert(std::isfinite(rate), "rate is not finite!");
456 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
458 xbt_assert(mbox, "No rendez-vous point defined for send");
460 if (MC_is_active() || MC_record_replay_is_active()) {
461 /* the model-checker wants two separate simcalls */
462 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
463 comm = simcall_comm_isend(sender, mbox, task_size, rate,
464 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
465 simcall_comm_wait(comm, timeout);
469 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
470 match_fun, copy_data_fun, data, timeout);
475 * \ingroup simix_comm_management
477 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
478 void *src_buff, size_t src_buff_size,
479 int (*match_fun)(void *, void *, smx_activity_t),
480 void (*clean_fun)(void *),
481 void (*copy_data_fun)(smx_activity_t, void*, size_t),
485 /* checking for infinite values */
486 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
487 xbt_assert(std::isfinite(rate), "rate is not finite!");
489 xbt_assert(mbox, "No rendez-vous point defined for isend");
491 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
492 src_buff_size, match_fun,
493 clean_fun, copy_data_fun, data, detached);
497 * \ingroup simix_comm_management
499 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t * dst_buff_size,
500 int (*match_fun)(void *, void *, smx_activity_t),
501 void (*copy_data_fun)(smx_activity_t, void*, size_t),
502 void *data, double timeout, double rate)
504 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
505 xbt_assert(mbox, "No rendez-vous point defined for recv");
507 if (MC_is_active() || MC_record_replay_is_active()) {
508 /* the model-checker wants two separate simcalls */
509 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
510 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
511 match_fun, copy_data_fun, data, rate);
512 simcall_comm_wait(comm, timeout);
516 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
517 match_fun, copy_data_fun, data, timeout, rate);
521 * \ingroup simix_comm_management
523 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t *dst_buff_size,
524 int (*match_fun)(void *, void *, smx_activity_t),
525 void (*copy_data_fun)(smx_activity_t, void*, size_t),
526 void *data, double rate)
528 xbt_assert(mbox, "No rendez-vous point defined for irecv");
530 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
531 match_fun, copy_data_fun, data, rate);
535 * \ingroup simix_comm_management
537 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
538 int (*match_fun)(void *, void *, smx_activity_t), void *data)
540 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
542 return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
546 * \ingroup simix_comm_management
548 void simcall_comm_cancel(smx_activity_t synchro)
550 simgrid::simix::kernelImmediate([synchro]{
551 simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
557 * \ingroup simix_comm_management
559 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
561 return simcall_BODY_comm_waitany(comms, timeout);
565 * \ingroup simix_comm_management
567 int simcall_comm_testany(smx_activity_t* comms, size_t count)
571 return simcall_BODY_comm_testany(comms, count);
575 * \ingroup simix_comm_management
577 void simcall_comm_wait(smx_activity_t comm, double timeout)
579 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
580 simcall_BODY_comm_wait(comm, timeout);
584 * \brief Set the category of an synchro.
586 * This functions changes the category only. It calls a surf function.
587 * \param execution The execution synchro
588 * \param category The tracing category
590 void simcall_set_category(smx_activity_t synchro, const char *category)
592 if (category == nullptr) {
595 simcall_BODY_set_category(synchro, category);
599 * \ingroup simix_comm_management
602 int simcall_comm_test(smx_activity_t comm)
604 return simcall_BODY_comm_test(comm);
608 * \ingroup simix_synchro_management
611 smx_mutex_t simcall_mutex_init()
614 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
617 return simcall_BODY_mutex_init();
621 * \ingroup simix_synchro_management
624 void simcall_mutex_lock(smx_mutex_t mutex)
626 simcall_BODY_mutex_lock(mutex);
630 * \ingroup simix_synchro_management
633 int simcall_mutex_trylock(smx_mutex_t mutex)
635 return simcall_BODY_mutex_trylock(mutex);
639 * \ingroup simix_synchro_management
642 void simcall_mutex_unlock(smx_mutex_t mutex)
644 simcall_BODY_mutex_unlock(mutex);
648 * \ingroup simix_synchro_management
651 smx_cond_t simcall_cond_init()
653 return simcall_BODY_cond_init();
657 * \ingroup simix_synchro_management
660 void simcall_cond_signal(smx_cond_t cond)
662 simcall_BODY_cond_signal(cond);
666 * \ingroup simix_synchro_management
669 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
671 simcall_BODY_cond_wait(cond, mutex);
675 * \ingroup simix_synchro_management
678 void simcall_cond_wait_timeout(smx_cond_t cond,
682 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
683 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
687 * \ingroup simix_synchro_management
690 void simcall_cond_broadcast(smx_cond_t cond)
692 simcall_BODY_cond_broadcast(cond);
696 * \ingroup simix_synchro_management
699 smx_sem_t simcall_sem_init(int capacity)
701 return simcall_BODY_sem_init(capacity);
705 * \ingroup simix_synchro_management
708 void simcall_sem_release(smx_sem_t sem)
710 simcall_BODY_sem_release(sem);
714 * \ingroup simix_synchro_management
717 int simcall_sem_would_block(smx_sem_t sem)
719 return simcall_BODY_sem_would_block(sem);
723 * \ingroup simix_synchro_management
726 void simcall_sem_acquire(smx_sem_t sem)
728 simcall_BODY_sem_acquire(sem);
732 * \ingroup simix_synchro_management
735 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
737 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
738 simcall_BODY_sem_acquire_timeout(sem, timeout);
742 * \ingroup simix_synchro_management
745 int simcall_sem_get_capacity(smx_sem_t sem)
747 return simcall_BODY_sem_get_capacity(sem);
751 * \ingroup simix_file_management
754 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
756 return simcall_BODY_file_read(fd, size, host);
760 * \ingroup simix_file_management
763 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
765 return simcall_BODY_file_write(fd, size, host);
769 * \ingroup simix_file_management
772 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
774 return simcall_BODY_file_open(fullpath, host);
778 * \ingroup simix_file_management
781 int simcall_file_close(smx_file_t fd, sg_host_t host)
783 return simcall_BODY_file_close(fd, host);
787 * \ingroup simix_file_management
790 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
792 return simcall_BODY_file_unlink(fd, host);
796 * \ingroup simix_file_management
799 sg_size_t simcall_file_get_size(smx_file_t fd){
800 return simcall_BODY_file_get_size(fd);
804 * \ingroup simix_file_management
807 sg_size_t simcall_file_tell(smx_file_t fd){
808 return simcall_BODY_file_tell(fd);
812 * \ingroup simix_file_management
815 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
817 return simcall_BODY_file_get_info(fd);
821 * \ingroup simix_file_management
824 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
825 return simcall_BODY_file_seek(fd, offset, origin);
829 * \ingroup simix_file_management
830 * \brief Move a file to another location on the *same mount point*.
833 int simcall_file_move(smx_file_t fd, const char* fullpath)
835 return simcall_BODY_file_move(fd, fullpath);
839 * \ingroup simix_storage_management
840 * \brief Returns the free space size on a given storage element.
841 * \param storage a storage
842 * \return Return the free space size on a given storage element (as sg_size_t)
844 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
845 return simcall_BODY_storage_get_free_size(storage);
849 * \ingroup simix_storage_management
850 * \brief Returns the used space size on a given storage element.
851 * \param storage a storage
852 * \return Return the used space size on a given storage element (as sg_size_t)
854 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
855 return simcall_BODY_storage_get_used_size(storage);
859 * \ingroup simix_storage_management
860 * \brief Returns a dict of the properties assigned to a storage element.
862 * \param storage A storage element
863 * \return The properties of this storage element
865 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
867 return simcall_BODY_storage_get_properties(storage);
871 * \ingroup simix_storage_management
872 * \brief Returns a dict containing the content of a storage element.
874 * \param storage A storage element
875 * \return The content of this storage element as a dict (full path file => size)
877 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
879 return simcall_BODY_storage_get_content(storage);
882 void simcall_run_kernel(std::function<void()> const& code)
884 simcall_BODY_run_kernel(&code);
887 void simcall_run_blocking(std::function<void()> const& code)
889 simcall_BODY_run_blocking(&code);
892 int simcall_mc_random(int min, int max) {
893 return simcall_BODY_mc_random(min, max);
896 /* ************************************************************************** */
898 /** @brief returns a printable string representing a simcall */
899 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
900 return simcall_names[kind];
906 void unblock(smx_actor_t process)
908 xbt_assert(SIMIX_is_maestro());
909 SIMIX_simcall_answer(&process->simcall);