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 actor)
40 if (actor != simix_global->maestro_process) {
41 XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->cname(), SIMIX_simcall_name(actor->simcall.call),
42 (int)actor->simcall.call);
43 SIMIX_process_yield(actor);
45 SIMIX_simcall_handle(&actor->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_process_management
166 * \brief Kills a SIMIX process.
168 * This function simply kills a process.
170 * \param process poor victim
172 void simcall_process_kill(smx_actor_t process)
174 simcall_BODY_process_kill(process);
178 * \ingroup simix_process_management
179 * \brief Kills all SIMIX processes.
181 void simcall_process_killall(int reset_pid)
183 simcall_BODY_process_killall(reset_pid);
187 * \ingroup simix_process_management
188 * \brief Cleans up a SIMIX process.
189 * \param process poor victim (must have already been killed)
191 void simcall_process_cleanup(smx_actor_t process)
193 simcall_BODY_process_cleanup(process);
197 * \ingroup simix_process_management
198 * \brief Migrates an agent to another location.
200 * This function changes the value of the host on which \a process is running.
202 * \param process the process to migrate
203 * \param dest name of the new host
205 void simcall_process_set_host(smx_actor_t process, sg_host_t dest)
207 simcall_BODY_process_set_host(process, dest);
210 void simcall_process_join(smx_actor_t process, double timeout)
212 simcall_BODY_process_join(process, timeout);
216 * \ingroup simix_process_management
217 * \brief Suspends a process.
219 * This function suspends the process by suspending the synchro
220 * it was waiting for completion.
222 * \param process a SIMIX process
224 void simcall_process_suspend(smx_actor_t process)
226 simcall_BODY_process_suspend(process);
230 * \ingroup simix_process_management
231 * \brief Resumes a suspended process.
233 * This function resumes a suspended process by resuming the synchro
234 * it was waiting for completion.
236 * \param process a SIMIX process
238 void simcall_process_resume(smx_actor_t process)
240 simcall_BODY_process_resume(process);
244 * \ingroup simix_process_management
245 * \brief Returns the amount of SIMIX processes in the system
247 * Maestro internal process is not counted, only user code processes are
249 int simcall_process_count()
251 return simgrid::simix::kernelImmediate(SIMIX_process_count);
255 * \ingroup simix_process_management
256 * \brief Return the user data of a #smx_actor_t.
257 * \param process a SIMIX process
258 * \return the user data of this process
260 void* simcall_process_get_data(smx_actor_t process)
262 return SIMIX_process_get_data(process);
266 * \ingroup simix_process_management
267 * \brief Set the user data of a #smx_actor_t.
269 * This functions sets the user data associated to \a process.
270 * \param process SIMIX process
271 * \param data User data
273 void simcall_process_set_data(smx_actor_t process, void *data)
275 simgrid::simix::kernelImmediate(std::bind(SIMIX_process_set_data, process, data));
279 * \ingroup simix_process_management
280 * \brief Set the kill time of a process.
282 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
285 if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
287 XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->cname());
288 process->kill_timer = SIMIX_timer_set(kill_time, [=] {
289 simix_global->kill_process_function(process);
290 process->kill_timer=nullptr;
294 * \ingroup simix_process_management
295 * \brief Get the kill time of a process (or 0 if unset).
297 double simcall_process_get_kill_time(smx_actor_t process) {
298 return SIMIX_timer_get_date(process->kill_timer);
302 * \ingroup simix_process_management
303 * \brief Returns true if the process is suspended .
305 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
306 * \param process SIMIX process
307 * \return 1, if the process is suspended, else 0.
309 int simcall_process_is_suspended(smx_actor_t process)
311 return simcall_BODY_process_is_suspended(process);
315 * \ingroup simix_process_management
316 * \brief Return the properties
318 * This functions returns the properties associated with this process
320 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
322 return SIMIX_process_get_properties(process);
325 * \ingroup simix_process_management
326 * \brief Add an on_exit function
327 * Add an on_exit function which will be executed when the process exits/is killed.
329 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
331 simcall_BODY_process_on_exit(process, fun, data);
334 * \ingroup simix_process_management
335 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
336 * Will restart the process when the host comes back up if auto_restart is set to 1.
339 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
341 simcall_BODY_process_auto_restart_set(process, auto_restart);
345 * \ingroup simix_process_management
346 * \brief Restarts the process, killing it and starting it again from scratch.
348 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
350 return (smx_actor_t) simcall_BODY_process_restart(process);
353 * \ingroup simix_process_management
354 * \brief Creates a new sleep SIMIX synchro.
356 * This function creates a SURF action and allocates the data necessary
357 * to create the SIMIX synchro. It can raise a host_error exception if the
358 * host crashed. The default SIMIX name of the synchro is "sleep".
360 * \param duration Time duration of the sleep.
361 * \return A result telling whether the sleep was successful
363 e_smx_state_t simcall_process_sleep(double duration)
365 /* checking for infinite values */
366 xbt_assert(std::isfinite(duration), "duration is not finite!");
367 return (e_smx_state_t) simcall_BODY_process_sleep(duration);
371 * \ingroup simix_comm_management
373 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
374 void *src_buff, size_t src_buff_size,
375 int (*match_fun)(void *, void *, smx_activity_t),
376 void (*copy_data_fun)(smx_activity_t, void*, size_t), void *data,
379 /* checking for infinite values */
380 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
381 xbt_assert(std::isfinite(rate), "rate is not finite!");
382 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
384 xbt_assert(mbox, "No rendez-vous point defined for send");
386 if (MC_is_active() || MC_record_replay_is_active()) {
387 /* the model-checker wants two separate simcalls */
388 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
389 comm = simcall_comm_isend(sender, mbox, task_size, rate,
390 src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
391 simcall_comm_wait(comm, timeout);
395 simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
396 match_fun, copy_data_fun, data, timeout);
401 * \ingroup simix_comm_management
403 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
404 void *src_buff, size_t src_buff_size,
405 int (*match_fun)(void *, void *, smx_activity_t),
406 void (*clean_fun)(void *),
407 void (*copy_data_fun)(smx_activity_t, void*, size_t),
411 /* checking for infinite values */
412 xbt_assert(std::isfinite(task_size), "task_size is not finite!");
413 xbt_assert(std::isfinite(rate), "rate is not finite!");
415 xbt_assert(mbox, "No rendez-vous point defined for isend");
417 return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
418 src_buff_size, match_fun,
419 clean_fun, copy_data_fun, data, detached);
423 * \ingroup simix_comm_management
425 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t * dst_buff_size,
426 int (*match_fun)(void *, void *, smx_activity_t),
427 void (*copy_data_fun)(smx_activity_t, void*, size_t),
428 void *data, double timeout, double rate)
430 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
431 xbt_assert(mbox, "No rendez-vous point defined for recv");
433 if (MC_is_active() || MC_record_replay_is_active()) {
434 /* the model-checker wants two separate simcalls */
435 smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
436 comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
437 match_fun, copy_data_fun, data, rate);
438 simcall_comm_wait(comm, timeout);
442 simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
443 match_fun, copy_data_fun, data, timeout, rate);
447 * \ingroup simix_comm_management
449 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t *dst_buff_size,
450 int (*match_fun)(void *, void *, smx_activity_t),
451 void (*copy_data_fun)(smx_activity_t, void*, size_t),
452 void *data, double rate)
454 xbt_assert(mbox, "No rendez-vous point defined for irecv");
456 return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
457 match_fun, copy_data_fun, data, rate);
461 * \ingroup simix_comm_management
463 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
464 int (*match_fun)(void *, void *, smx_activity_t), void *data)
466 xbt_assert(mbox, "No rendez-vous point defined for iprobe");
468 return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
472 * \ingroup simix_comm_management
474 void simcall_comm_cancel(smx_activity_t synchro)
476 simgrid::simix::kernelImmediate([synchro]{
477 simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
483 * \ingroup simix_comm_management
485 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
487 return simcall_BODY_comm_waitany(comms, timeout);
491 * \ingroup simix_comm_management
493 int simcall_comm_testany(smx_activity_t* comms, size_t count)
497 return simcall_BODY_comm_testany(comms, count);
501 * \ingroup simix_comm_management
503 void simcall_comm_wait(smx_activity_t comm, double timeout)
505 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
506 simcall_BODY_comm_wait(comm, timeout);
510 * \brief Set the category of an synchro.
512 * This functions changes the category only. It calls a surf function.
513 * \param synchro The execution synchro
514 * \param category The tracing category
516 void simcall_set_category(smx_activity_t synchro, const char *category)
518 if (category == nullptr) {
521 simcall_BODY_set_category(synchro, category);
525 * \ingroup simix_comm_management
528 int simcall_comm_test(smx_activity_t comm)
530 return simcall_BODY_comm_test(comm);
534 * \ingroup simix_synchro_management
537 smx_mutex_t simcall_mutex_init()
540 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
543 return simcall_BODY_mutex_init();
547 * \ingroup simix_synchro_management
550 void simcall_mutex_lock(smx_mutex_t mutex)
552 simcall_BODY_mutex_lock(mutex);
556 * \ingroup simix_synchro_management
559 int simcall_mutex_trylock(smx_mutex_t mutex)
561 return simcall_BODY_mutex_trylock(mutex);
565 * \ingroup simix_synchro_management
568 void simcall_mutex_unlock(smx_mutex_t mutex)
570 simcall_BODY_mutex_unlock(mutex);
574 * \ingroup simix_synchro_management
577 smx_cond_t simcall_cond_init()
579 return simcall_BODY_cond_init();
583 * \ingroup simix_synchro_management
586 void simcall_cond_signal(smx_cond_t cond)
588 simcall_BODY_cond_signal(cond);
592 * \ingroup simix_synchro_management
595 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
597 simcall_BODY_cond_wait(cond, mutex);
601 * \ingroup simix_synchro_management
604 void simcall_cond_wait_timeout(smx_cond_t cond,
608 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
609 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
613 * \ingroup simix_synchro_management
616 void simcall_cond_broadcast(smx_cond_t cond)
618 simcall_BODY_cond_broadcast(cond);
622 * \ingroup simix_synchro_management
625 smx_sem_t simcall_sem_init(int capacity)
627 return simcall_BODY_sem_init(capacity);
631 * \ingroup simix_synchro_management
634 void simcall_sem_release(smx_sem_t sem)
636 simcall_BODY_sem_release(sem);
640 * \ingroup simix_synchro_management
643 int simcall_sem_would_block(smx_sem_t sem)
645 return simcall_BODY_sem_would_block(sem);
649 * \ingroup simix_synchro_management
652 void simcall_sem_acquire(smx_sem_t sem)
654 simcall_BODY_sem_acquire(sem);
658 * \ingroup simix_synchro_management
661 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
663 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
664 simcall_BODY_sem_acquire_timeout(sem, timeout);
668 * \ingroup simix_synchro_management
671 int simcall_sem_get_capacity(smx_sem_t sem)
673 return simcall_BODY_sem_get_capacity(sem);
677 * \ingroup simix_file_management
680 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
682 return simcall_BODY_file_read(fd, size, host);
686 * \ingroup simix_file_management
689 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
691 return simcall_BODY_file_write(fd, size, host);
695 * \ingroup simix_file_management
698 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
700 return simcall_BODY_file_open(fullpath, host);
704 * \ingroup simix_file_management
707 int simcall_file_close(smx_file_t fd, sg_host_t host)
709 return simcall_BODY_file_close(fd, host);
713 * \ingroup simix_file_management
716 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
718 return simcall_BODY_file_unlink(fd, host);
722 * \ingroup simix_file_management
725 sg_size_t simcall_file_get_size(smx_file_t fd){
726 return simcall_BODY_file_get_size(fd);
730 * \ingroup simix_file_management
733 sg_size_t simcall_file_tell(smx_file_t fd){
734 return simcall_BODY_file_tell(fd);
738 * \ingroup simix_file_management
741 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
743 return simcall_BODY_file_get_info(fd);
747 * \ingroup simix_file_management
750 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
751 return simcall_BODY_file_seek(fd, offset, origin);
755 * \ingroup simix_file_management
756 * \brief Move a file to another location on the *same mount point*.
759 int simcall_file_move(smx_file_t fd, const char* fullpath)
761 return simcall_BODY_file_move(fd, fullpath);
765 * \ingroup simix_storage_management
766 * \brief Returns the free space size on a given storage element.
767 * \param storage a storage
768 * \return Return the free space size on a given storage element (as sg_size_t)
770 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
771 return simcall_BODY_storage_get_free_size(storage);
775 * \ingroup simix_storage_management
776 * \brief Returns the used space size on a given storage element.
777 * \param storage a storage
778 * \return Return the used space size on a given storage element (as sg_size_t)
780 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
781 return simcall_BODY_storage_get_used_size(storage);
785 * \ingroup simix_storage_management
786 * \brief Returns a dict of the properties assigned to a storage element.
788 * \param storage A storage element
789 * \return The properties of this storage element
791 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
793 return simcall_BODY_storage_get_properties(storage);
797 * \ingroup simix_storage_management
798 * \brief Returns a dict containing the content of a storage element.
800 * \param storage A storage element
801 * \return The content of this storage element as a dict (full path file => size)
803 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
805 return simcall_BODY_storage_get_content(storage);
808 void simcall_run_kernel(std::function<void()> const& code)
810 simcall_BODY_run_kernel(&code);
813 void simcall_run_blocking(std::function<void()> const& code)
815 simcall_BODY_run_blocking(&code);
818 int simcall_mc_random(int min, int max) {
819 return simcall_BODY_mc_random(min, max);
822 /* ************************************************************************** */
824 /** @brief returns a printable string representing a simcall */
825 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
826 return simcall_names[kind];
832 void unblock(smx_actor_t process)
834 xbt_assert(SIMIX_is_maestro());
835 SIMIX_simcall_answer(&process->simcall);