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 "src/mc/mc_replay.h"
15 #include "smx_private.h"
16 #include "src/mc/mc_forward.h"
18 #include <math.h> /* isfinite() */
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
23 #include "popping_bodies.c"
26 * \ingroup simix_host_management
27 * \brief Start the host if it is off
29 * \param host A SIMIX host
31 void simcall_host_on(sg_host_t host)
33 simcall_BODY_host_on(host);
37 * \ingroup simix_host_management
38 * \brief Stop the host if it is on
40 * \param host A SIMIX host
42 void simcall_host_off(sg_host_t host)
44 simcall_BODY_host_off(host);
48 * \ingroup simix_host_management
49 * \brief Returns a dict of the properties assigned to a host.
52 * \return The properties of this host
54 xbt_dict_t simcall_host_get_properties(sg_host_t host)
56 return simcall_BODY_host_get_properties(host);
60 * \ingroup simix_host_management
61 * \brief Returns a dict of the properties assigned to a router or AS.
63 * \param name The name of the router or AS
64 * \return The properties
66 xbt_dict_t simcall_asr_get_properties(const char *name)
68 return simcall_BODY_asr_get_properties(name);
73 * \ingroup simix_host_management
74 * \brief Returns the speed of the processor.
76 * The speed returned does not take into account the current load on the machine.
77 * \param host A SIMIX host
78 * \return The speed of this host (in Mflop/s)
80 double simcall_host_get_speed(sg_host_t host)
82 return simcall_BODY_host_get_speed(host);
86 * \ingroup simix_host_management
87 * \brief Returns the number of core of the processor.
89 * \param host A SIMIX host
90 * \return The number of core
92 int simcall_host_get_core(sg_host_t host)
94 return simcall_BODY_host_get_core(host);
98 * \ingroup simix_host_management
99 * \brief Returns the list of processes attached to the host.
101 * \param host A SIMIX host
102 * \return the swag of attached processes
104 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
106 return simcall_BODY_host_get_process_list(host);
111 * \ingroup simix_host_management
112 * \brief Returns the available speed of the processor.
114 * \return Speed currently available (in Mflop/s)
116 double simcall_host_get_available_speed(sg_host_t host)
118 return simcall_BODY_host_get_available_speed(host);
122 * \ingroup simix_host_management
123 * \brief Returns the state of a host.
125 * Two states are possible: 1 if the host is active or 0 if it has crashed.
126 * \param host A SIMIX host
127 * \return 1 if the host is available, 0 otherwise
129 int simcall_host_get_state(sg_host_t host)
131 return simcall_BODY_host_get_state(host);
135 * \ingroup simix_host_management
136 * \brief Returns the power peak of a host.
138 * \param host A SIMIX host
139 * \return the current power peak value (double)
141 double simcall_host_get_current_power_peak(sg_host_t host)
143 return simcall_BODY_host_get_current_power_peak(host);
147 * \ingroup simix_host_management
148 * \brief Returns one power peak (in flops/s) of a host at a given pstate
150 * \param host A SIMIX host
151 * \param pstate_index pstate to test
152 * \return the current power peak value (double) for pstate_index
154 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
156 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
160 * \ingroup simix_host_management
161 * \brief Returns the number of power states for a host.
163 * \param host A SIMIX host
164 * \return the number of power states
166 int simcall_host_get_nb_pstates(sg_host_t host)
168 return simcall_BODY_host_get_nb_pstates(host);
172 * \ingroup simix_host_management
173 * \brief Sets the pstate at which the host should run
175 * \param host A SIMIX host
176 * \param pstate_index The pstate to which the CPU power will be set
178 void simcall_host_set_pstate(sg_host_t host, int pstate_index)
180 simcall_BODY_host_set_pstate(host, pstate_index);
183 * \ingroup simix_host_management
184 * \brief Gets the pstate at which that host currently runs.
186 * \param host A SIMIX host
188 int simcall_host_get_pstate(sg_host_t host)
190 return simcall_BODY_host_get_pstate(host);
194 * \ingroup simix_host_management
195 * \brief Returns the total energy consumed by the host (in Joules)
197 * \param host A SIMIX host
198 * \return the energy consumed by the host (double)
200 double simcall_host_get_consumed_energy(sg_host_t host)
202 return simcall_BODY_host_get_consumed_energy(host);
204 /** \ingroup simix_host_management
205 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
207 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
208 return simcall_BODY_host_get_wattmin_at(host, pstate);
210 /** \ingroup simix_host_management
211 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
213 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
214 return simcall_BODY_host_get_wattmax_at(host, pstate);
220 * \ingroup simix_process_management
221 * \brief Creates a synchro that executes some computation of an host.
223 * This function creates a SURF action and allocates the data necessary
224 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
226 * \param name Name of the execution synchro to create
227 * \param flops_amount amount Computation amount (in flops)
228 * \param priority computation priority
230 * \param affinity_mask
231 * \return A new SIMIX execution synchronization
233 smx_synchro_t simcall_process_execute(const char *name,
235 double priority, double bound, unsigned long affinity_mask)
237 /* checking for infinite values */
238 xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
239 xbt_assert(isfinite(priority), "priority is not finite!");
241 return simcall_BODY_process_execute(name, flops_amount, priority, bound, affinity_mask);
245 * \ingroup simix_process_management
246 * \brief Creates a synchro that may involve parallel computation on
247 * several hosts and communication between them.
249 * \param name Name of the execution synchro to create
250 * \param host_nb Number of hosts where the synchro will be executed
251 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
252 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
253 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
254 * amount between each pair of hosts
255 * \param amount the SURF action amount
256 * \param rate the SURF action rate
257 * \return A new SIMIX execution synchronization
259 smx_synchro_t simcall_process_parallel_execute(const char *name,
261 sg_host_t *host_list,
262 double *flops_amount,
263 double *bytes_amount,
268 /* checking for infinite values */
269 for (i = 0 ; i < host_nb ; ++i) {
270 xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
271 for (j = 0 ; j < host_nb ; ++j) {
272 xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
273 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
277 xbt_assert(isfinite(amount), "amount is not finite!");
278 xbt_assert(isfinite(rate), "rate is not finite!");
280 return simcall_BODY_process_parallel_execute(name, host_nb, host_list,
288 * \ingroup simix_process_management
289 * \brief Destroys an execution synchro.
291 * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
292 * \param execution The execution synchro to destroy
294 void simcall_process_execution_destroy(smx_synchro_t execution)
296 simcall_BODY_process_execution_destroy(execution);
300 * \ingroup simix_process_management
301 * \brief Cancels an execution synchro.
303 * This functions stops the execution. It calls a surf function.
304 * \param execution The execution synchro to cancel
306 void simcall_process_execution_cancel(smx_synchro_t execution)
308 simcall_BODY_process_execution_cancel(execution);
312 * \ingroup simix_process_management
313 * \brief Returns how much of an execution synchro remains to be done.
315 * \param execution The execution synchro
316 * \return The remaining amount
318 double simcall_process_execution_get_remains(smx_synchro_t execution)
320 return simcall_BODY_process_execution_get_remains(execution);
324 * \ingroup simix_process_management
325 * \brief Returns the state of an execution synchro.
327 * \param execution The execution synchro
330 e_smx_state_t simcall_process_execution_get_state(smx_synchro_t execution)
332 return simcall_BODY_process_execution_get_state(execution);
336 * \ingroup simix_process_management
337 * \brief Changes the priority of an execution synchro.
339 * This functions changes the priority only. It calls a surf function.
340 * \param execution The execution synchro
341 * \param priority The new priority
343 void simcall_process_execution_set_priority(smx_synchro_t execution, double priority)
345 /* checking for infinite values */
346 xbt_assert(isfinite(priority), "priority is not finite!");
348 simcall_BODY_process_execution_set_priority(execution, priority);
352 * \ingroup simix_process_management
353 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
355 * This functions changes the capping only. It calls a surf function.
356 * \param execution The execution synchro
357 * \param bound The new bound
359 void simcall_process_execution_set_bound(smx_synchro_t execution, double bound)
361 simcall_BODY_process_execution_set_bound(execution, bound);
365 * \ingroup simix_process_management
366 * \brief Changes the CPU affinity of an execution synchro.
368 * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
369 * \param execution The execution synchro
371 * \param mask Affinity mask
373 void simcall_process_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
375 simcall_BODY_process_execution_set_affinity(execution, host, mask);
379 * \ingroup simix_host_management
380 * \brief Waits for the completion of an execution synchro and destroy it.
382 * \param execution The execution synchro
384 e_smx_state_t simcall_process_execution_wait(smx_synchro_t execution)
386 return simcall_BODY_process_execution_wait(execution);
391 * \ingroup simix_vm_management
392 * \brief Create a VM on the given physical host.
394 * \param name VM name
395 * \param host Physical host
397 * \return The host object of the VM
399 void* simcall_vm_create(const char *name, sg_host_t phys_host){
400 return simcall_BODY_vm_create(name, phys_host);
404 * \ingroup simix_vm_management
405 * \brief Start the given VM to the given physical host
409 void simcall_vm_start(sg_host_t vm)
411 simcall_BODY_vm_start(vm);
415 * \ingroup simix_vm_management
416 * \brief Get the state of the given VM
419 * \return The state of the VM
421 int simcall_vm_get_state(sg_host_t vm)
423 return simcall_BODY_vm_get_state(vm);
427 * \ingroup simix_vm_management
428 * \brief Get the name of the physical host on which the given VM runs.
431 * \return The name of the physical host
433 void *simcall_vm_get_pm(sg_host_t vm)
435 return simcall_BODY_vm_get_pm(vm);
438 void simcall_vm_set_bound(sg_host_t vm, double bound)
440 simcall_BODY_vm_set_bound(vm, bound);
443 void simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask)
445 simcall_BODY_vm_set_affinity(vm, pm, mask);
448 void simcall_host_get_params(sg_host_t vm, vm_params_t params)
450 simcall_BODY_host_get_params(vm, params);
453 void simcall_host_set_params(sg_host_t vm, vm_params_t params)
455 simcall_BODY_host_set_params(vm, params);
459 * \ingroup simix_vm_management
460 * \brief Migrate the given VM to the given physical host
463 * \param host Destination physical host
465 void simcall_vm_migrate(sg_host_t vm, sg_host_t host)
467 simcall_BODY_vm_migrate(vm, host);
471 * \ingroup simix_vm_management
472 * \brief Suspend the given VM
476 void simcall_vm_suspend(sg_host_t vm)
478 simcall_BODY_vm_suspend(vm);
482 * \ingroup simix_vm_management
483 * \brief Resume the given VM
487 void simcall_vm_resume(sg_host_t vm)
489 simcall_BODY_vm_resume(vm);
493 * \ingroup simix_vm_management
494 * \brief Save the given VM
498 void simcall_vm_save(sg_host_t vm)
500 simcall_BODY_vm_save(vm);
504 * \ingroup simix_vm_management
505 * \brief Restore the given VM
509 void simcall_vm_restore(sg_host_t vm)
511 simcall_BODY_vm_restore(vm);
515 * \ingroup simix_vm_management
516 * \brief Shutdown the given VM
520 void simcall_vm_shutdown(sg_host_t vm)
522 simcall_BODY_vm_shutdown(vm);
526 * \ingroup simix_vm_management
527 * \brief Destroy the given VM
531 void simcall_vm_destroy(sg_host_t vm)
533 simcall_BODY_vm_destroy(vm);
537 * \ingroup simix_vm_management
538 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
539 * The simcall actually invokes the following calls:
540 * simcall_vm_set_affinity(vm, src_pm, 0);
541 * simcall_vm_migrate(vm, dst_pm);
542 * simcall_vm_resume(vm);
544 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
546 * \param vm VM to migrate
547 * \param src_pm Source physical host
548 * \param dst_pmt Destination physical host
550 void simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
552 simcall_BODY_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
556 * \ingroup simix_process_management
557 * \brief Creates and runs a new SIMIX process.
559 * The structure and the corresponding thread are created and put in the list of ready processes.
561 * \param name a name for the process. It is for user-level information and can be NULL.
562 * \param code the main function of the process
563 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can be NULL.
564 * It can be retrieved with the function \ref simcall_process_get_data.
565 * \param hostname name of the host where the new agent is executed.
566 * \param kill_time time when the process is killed
567 * \param argc first argument passed to \a code
568 * \param argv second argument passed to \a code
569 * \param properties the properties of the process
570 * \param auto_restart either it is autorestarting or not.
572 smx_process_t simcall_process_create(const char *name,
573 xbt_main_func_t code,
575 const char *hostname,
577 int argc, char **argv,
578 xbt_dict_t properties,
581 return (smx_process_t) simcall_BODY_process_create(name, code, data, hostname,
582 kill_time, argc, argv, properties,
587 * \ingroup simix_process_management
588 * \brief Kills a SIMIX process.
590 * This function simply kills a process.
592 * \param process poor victim
594 void simcall_process_kill(smx_process_t process)
596 simcall_BODY_process_kill(process);
600 * \ingroup simix_process_management
601 * \brief Kills all SIMIX processes.
603 void simcall_process_killall(int reset_pid)
605 simcall_BODY_process_killall(reset_pid);
609 * \ingroup simix_process_management
610 * \brief Cleans up a SIMIX process.
611 * \param process poor victim (must have already been killed)
613 void simcall_process_cleanup(smx_process_t process)
615 simcall_BODY_process_cleanup(process);
619 * \ingroup simix_process_management
620 * \brief Migrates an agent to another location.
622 * This function changes the value of the host on which \a process is running.
624 * \param process the process to migrate
625 * \param dest name of the new host
627 void simcall_process_set_host(smx_process_t process, sg_host_t dest)
629 simcall_BODY_process_set_host(process, dest);
632 void simcall_process_join(smx_process_t process, double timeout)
634 simcall_BODY_process_join(process, timeout);
638 * \ingroup simix_process_management
639 * \brief Suspends a process.
641 * This function suspends the process by suspending the synchro
642 * it was waiting for completion.
644 * \param process a SIMIX process
646 void simcall_process_suspend(smx_process_t process)
648 xbt_assert(process, "Invalid parameters");
650 simcall_BODY_process_suspend(process);
654 * \ingroup simix_process_management
655 * \brief Resumes a suspended process.
657 * This function resumes a suspended process by resuming the synchro
658 * it was waiting for completion.
660 * \param process a SIMIX process
662 void simcall_process_resume(smx_process_t process)
664 simcall_BODY_process_resume(process);
668 * \ingroup simix_process_management
669 * \brief Returns the amount of SIMIX processes in the system
671 * Maestro internal process is not counted, only user code processes are
673 int simcall_process_count(void)
675 return simcall_BODY_process_count();
679 * \ingroup simix_process_management
680 * \brief Return the PID of a #smx_process_t.
681 * \param process a SIMIX process
682 * \return the PID of this process
684 int simcall_process_get_PID(smx_process_t process)
686 if (process == SIMIX_process_self()) {
687 /* avoid a simcall if this function is called by the process itself */
688 return SIMIX_process_get_PID(process);
691 return simcall_BODY_process_get_PID(process);
695 * \ingroup simix_process_management
696 * \brief Return the parent PID of a #smx_process_t.
697 * \param process a SIMIX process
698 * \return the PID of this process parenrt
700 int simcall_process_get_PPID(smx_process_t process)
702 if (process == SIMIX_process_self()) {
703 /* avoid a simcall if this function is called by the process itself */
704 return SIMIX_process_get_PPID(process);
707 return simcall_BODY_process_get_PPID(process);
711 * \ingroup simix_process_management
712 * \brief Return the user data of a #smx_process_t.
713 * \param process a SIMIX process
714 * \return the user data of this process
716 void* simcall_process_get_data(smx_process_t process)
718 if (process == SIMIX_process_self()) {
719 /* avoid a simcall if this function is called by the process itself */
720 return SIMIX_process_get_data(process);
723 return simcall_BODY_process_get_data(process);
727 * \ingroup simix_process_management
728 * \brief Set the user data of a #smx_process_t.
730 * This functions sets the user data associated to \a process.
731 * \param process SIMIX process
732 * \param data User data
734 void simcall_process_set_data(smx_process_t process, void *data)
736 if (process == SIMIX_process_self()) {
737 /* avoid a simcall if this function is called by the process itself */
738 SIMIX_process_self_set_data(process, data);
741 simcall_BODY_process_set_data(process, data);
746 * \ingroup simix_process_management
747 * \brief Set the kill time of a process.
749 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
752 if (kill_time > SIMIX_get_clock()) {
753 if (simix_global->kill_process_function) {
754 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
755 sg_host_name(process->host));
756 process->kill_timer = SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
761 * \ingroup simix_process_management
762 * \brief Get the kill time of a process (or 0 if unset).
764 double simcall_process_get_kill_time(smx_process_t process) {
765 return SIMIX_timer_get_date(process->kill_timer);
769 * \ingroup simix_process_management
770 * \brief Return the location on which an agent is running.
772 * This functions returns the sg_host_t corresponding to the location on which
773 * \a process is running.
774 * \param process SIMIX process
777 sg_host_t simcall_process_get_host(smx_process_t process)
779 return simcall_BODY_process_get_host(process);
783 * \ingroup simix_process_management
784 * \brief Return the name of an agent.
786 * This functions checks whether \a process is a valid pointer or not and return its name.
787 * \param process SIMIX process
788 * \return The process name
790 const char* simcall_process_get_name(smx_process_t process)
792 if (process == SIMIX_process_self()) {
793 /* avoid a simcall if this function is called by the process itself */
794 return process->name;
796 return simcall_BODY_process_get_name(process);
800 * \ingroup simix_process_management
801 * \brief Returns true if the process is suspended .
803 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
804 * \param process SIMIX process
805 * \return 1, if the process is suspended, else 0.
807 int simcall_process_is_suspended(smx_process_t process)
809 return simcall_BODY_process_is_suspended(process);
813 * \ingroup simix_process_management
814 * \brief Return the properties
816 * This functions returns the properties associated with this process
818 xbt_dict_t simcall_process_get_properties(smx_process_t process)
820 return simcall_BODY_process_get_properties(process);
823 * \ingroup simix_process_management
824 * \brief Add an on_exit function
825 * Add an on_exit function which will be executed when the process exits/is killed.
827 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
829 simcall_BODY_process_on_exit(process, fun, data);
832 * \ingroup simix_process_management
833 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
834 * Will restart the process when the host comes back up if auto_restart is set to 1.
837 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
839 simcall_BODY_process_auto_restart_set(process, auto_restart);
843 * \ingroup simix_process_management
844 * \brief Restarts the process, killing it and starting it again from scratch.
846 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
848 return simcall_BODY_process_restart(process);
851 * \ingroup simix_process_management
852 * \brief Creates a new sleep SIMIX synchro.
854 * This function creates a SURF action and allocates the data necessary
855 * to create the SIMIX synchro. It can raise a host_error exception if the
856 * host crashed. The default SIMIX name of the synchro is "sleep".
858 * \param duration Time duration of the sleep.
859 * \return A result telling whether the sleep was successful
861 e_smx_state_t simcall_process_sleep(double duration)
863 /* checking for infinite values */
864 xbt_assert(isfinite(duration), "duration is not finite!");
865 return simcall_BODY_process_sleep(duration);
869 * \ingroup simix_rdv_management
870 * \brief Creates a new rendez-vous point
871 * \param name The name of the rendez-vous point
872 * \return The created rendez-vous point
874 smx_rdv_t simcall_rdv_create(const char *name)
876 return simcall_BODY_rdv_create(name);
881 * \ingroup simix_rdv_management
882 * \brief Destroy a rendez-vous point
883 * \param rdv The rendez-vous point to destroy
885 void simcall_rdv_destroy(smx_rdv_t rdv)
887 simcall_BODY_rdv_destroy(rdv);
890 * \ingroup simix_rdv_management
891 * \brief Returns a rendez-vous point knowing its name
893 smx_rdv_t simcall_rdv_get_by_name(const char *name)
895 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
897 /* FIXME: this is a horrible loss of performance, so we hack it out by
898 * skipping the simcall (for now). It works in parallel, it won't work on
899 * distributed but probably we will change MSG for that. */
901 return SIMIX_rdv_get_by_name(name);
905 * \ingroup simix_rdv_management
906 * \brief Counts the number of communication synchros of a given host pending
907 * on a rendez-vous point.
908 * \param rdv The rendez-vous point
909 * \param host The host to be counted
910 * \return The number of comm synchros pending in the rdv
912 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
914 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
918 * \ingroup simix_rdv_management
919 * \brief returns the communication at the head of the rendez-vous
920 * \param rdv The rendez-vous point
921 * \return The communication or NULL if empty
923 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
925 return simcall_BODY_rdv_get_head(rdv);
928 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
930 simcall_BODY_rdv_set_receiver(rdv, process);
933 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
935 return simcall_BODY_rdv_get_receiver(rdv);
939 * \ingroup simix_comm_management
941 void simcall_comm_send(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
942 void *src_buff, size_t src_buff_size,
943 int (*match_fun)(void *, void *, smx_synchro_t),
944 void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
947 /* checking for infinite values */
948 xbt_assert(isfinite(task_size), "task_size is not finite!");
949 xbt_assert(isfinite(rate), "rate is not finite!");
950 xbt_assert(isfinite(timeout), "timeout is not finite!");
952 xbt_assert(rdv, "No rendez-vous point defined for send");
954 if (MC_is_active() || MC_record_replay_is_active()) {
955 /* the model-checker wants two separate simcalls */
956 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
957 comm = simcall_comm_isend(sender, rdv, task_size, rate,
958 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
959 simcall_comm_wait(comm, timeout);
963 simcall_BODY_comm_send(sender, rdv, task_size, rate, src_buff, src_buff_size,
964 match_fun, copy_data_fun, data, timeout);
969 * \ingroup simix_comm_management
971 smx_synchro_t simcall_comm_isend(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
972 void *src_buff, size_t src_buff_size,
973 int (*match_fun)(void *, void *, smx_synchro_t),
974 void (*clean_fun)(void *),
975 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
979 /* checking for infinite values */
980 xbt_assert(isfinite(task_size), "task_size is not finite!");
981 xbt_assert(isfinite(rate), "rate is not finite!");
983 xbt_assert(rdv, "No rendez-vous point defined for isend");
985 return simcall_BODY_comm_isend(sender, rdv, task_size, rate, src_buff,
986 src_buff_size, match_fun,
987 clean_fun, copy_data_fun, data, detached);
991 * \ingroup simix_comm_management
993 void simcall_comm_recv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
994 int (*match_fun)(void *, void *, smx_synchro_t),
995 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
996 void *data, double timeout, double rate)
998 xbt_assert(isfinite(timeout), "timeout is not finite!");
999 xbt_assert(rdv, "No rendez-vous point defined for recv");
1001 if (MC_is_active() || MC_record_replay_is_active()) {
1002 /* the model-checker wants two separate simcalls */
1003 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
1004 comm = simcall_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
1005 match_fun, copy_data_fun, data, rate);
1006 simcall_comm_wait(comm, timeout);
1010 simcall_BODY_comm_recv(receiver, rdv, dst_buff, dst_buff_size,
1011 match_fun, copy_data_fun, data, timeout, rate);
1015 * \ingroup simix_comm_management
1017 smx_synchro_t simcall_comm_irecv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1018 int (*match_fun)(void *, void *, smx_synchro_t),
1019 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1020 void *data, double rate)
1022 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1024 return simcall_BODY_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
1025 match_fun, copy_data_fun, data, rate);
1029 * \ingroup simix_comm_management
1031 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1032 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1034 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1036 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1040 * \ingroup simix_comm_management
1042 void simcall_comm_cancel(smx_synchro_t comm)
1044 simcall_BODY_comm_cancel(comm);
1048 * \ingroup simix_comm_management
1050 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1052 return simcall_BODY_comm_waitany(comms);
1056 * \ingroup simix_comm_management
1058 int simcall_comm_testany(xbt_dynar_t comms)
1060 if (xbt_dynar_is_empty(comms))
1062 return simcall_BODY_comm_testany(comms);
1066 * \ingroup simix_comm_management
1068 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1070 xbt_assert(isfinite(timeout), "timeout is not finite!");
1071 simcall_BODY_comm_wait(comm, timeout);
1075 * \brief Set the category of an synchro.
1077 * This functions changes the category only. It calls a surf function.
1078 * \param execution The execution synchro
1079 * \param category The tracing category
1081 void simcall_set_category(smx_synchro_t synchro, const char *category)
1083 if (category == NULL) {
1086 simcall_BODY_set_category(synchro, category);
1090 * \ingroup simix_comm_management
1093 int simcall_comm_test(smx_synchro_t comm)
1095 return simcall_BODY_comm_test(comm);
1099 * \ingroup simix_comm_management
1102 double simcall_comm_get_remains(smx_synchro_t comm)
1104 return simcall_BODY_comm_get_remains(comm);
1108 * \ingroup simix_comm_management
1111 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1113 return simcall_BODY_comm_get_state(comm);
1117 * \ingroup simix_comm_management
1120 void *simcall_comm_get_src_data(smx_synchro_t comm)
1122 return simcall_BODY_comm_get_src_data(comm);
1126 * \ingroup simix_comm_management
1129 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1131 return simcall_BODY_comm_get_dst_data(comm);
1135 * \ingroup simix_comm_management
1138 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1140 return simcall_BODY_comm_get_src_proc(comm);
1144 * \ingroup simix_comm_management
1147 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1149 return simcall_BODY_comm_get_dst_proc(comm);
1152 #ifdef HAVE_LATENCY_BOUND_TRACKING
1153 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1155 return simcall_BODY_comm_is_latency_bounded(comm);
1160 * \ingroup simix_synchro_management
1163 smx_mutex_t simcall_mutex_init(void)
1166 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
1169 return simcall_BODY_mutex_init();
1173 * \ingroup simix_synchro_management
1176 void simcall_mutex_destroy(smx_mutex_t mutex)
1178 simcall_BODY_mutex_destroy(mutex);
1182 * \ingroup simix_synchro_management
1185 void simcall_mutex_lock(smx_mutex_t mutex)
1187 simcall_BODY_mutex_lock(mutex);
1191 * \ingroup simix_synchro_management
1194 int simcall_mutex_trylock(smx_mutex_t mutex)
1196 return simcall_BODY_mutex_trylock(mutex);
1200 * \ingroup simix_synchro_management
1203 void simcall_mutex_unlock(smx_mutex_t mutex)
1205 simcall_BODY_mutex_unlock(mutex);
1209 * \ingroup simix_synchro_management
1212 smx_cond_t simcall_cond_init(void)
1214 return simcall_BODY_cond_init();
1218 * \ingroup simix_synchro_management
1221 void simcall_cond_destroy(smx_cond_t cond)
1223 simcall_BODY_cond_destroy(cond);
1227 * \ingroup simix_synchro_management
1230 void simcall_cond_signal(smx_cond_t cond)
1232 simcall_BODY_cond_signal(cond);
1236 * \ingroup simix_synchro_management
1239 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1241 simcall_BODY_cond_wait(cond, mutex);
1245 * \ingroup simix_synchro_management
1248 void simcall_cond_wait_timeout(smx_cond_t cond,
1252 xbt_assert(isfinite(timeout), "timeout is not finite!");
1253 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1257 * \ingroup simix_synchro_management
1260 void simcall_cond_broadcast(smx_cond_t cond)
1262 simcall_BODY_cond_broadcast(cond);
1266 * \ingroup simix_synchro_management
1269 smx_sem_t simcall_sem_init(int capacity)
1271 return simcall_BODY_sem_init(capacity);
1275 * \ingroup simix_synchro_management
1278 void simcall_sem_destroy(smx_sem_t sem)
1280 simcall_BODY_sem_destroy(sem);
1284 * \ingroup simix_synchro_management
1287 void simcall_sem_release(smx_sem_t sem)
1289 simcall_BODY_sem_release(sem);
1293 * \ingroup simix_synchro_management
1296 int simcall_sem_would_block(smx_sem_t sem)
1298 return simcall_BODY_sem_would_block(sem);
1302 * \ingroup simix_synchro_management
1305 void simcall_sem_acquire(smx_sem_t sem)
1307 simcall_BODY_sem_acquire(sem);
1311 * \ingroup simix_synchro_management
1314 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1316 xbt_assert(isfinite(timeout), "timeout is not finite!");
1317 simcall_BODY_sem_acquire_timeout(sem, timeout);
1321 * \ingroup simix_synchro_management
1324 int simcall_sem_get_capacity(smx_sem_t sem)
1326 return simcall_BODY_sem_get_capacity(sem);
1330 * \ingroup simix_file_management
1333 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1335 return simcall_BODY_file_read(fd, size, host);
1339 * \ingroup simix_file_management
1342 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1344 return simcall_BODY_file_write(fd, size, host);
1348 * \ingroup simix_file_management
1351 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1353 return simcall_BODY_file_open(fullpath, host);
1357 * \ingroup simix_file_management
1360 int simcall_file_close(smx_file_t fd, sg_host_t host)
1362 return simcall_BODY_file_close(fd, host);
1366 * \ingroup simix_file_management
1369 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1371 return simcall_BODY_file_unlink(fd, host);
1375 * \ingroup simix_file_management
1378 sg_size_t simcall_file_get_size(smx_file_t fd){
1379 return simcall_BODY_file_get_size(fd);
1383 * \ingroup simix_file_management
1386 sg_size_t simcall_file_tell(smx_file_t fd){
1387 return simcall_BODY_file_tell(fd);
1391 * \ingroup simix_file_management
1394 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1396 return simcall_BODY_file_get_info(fd);
1400 * \ingroup simix_file_management
1403 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1404 return simcall_BODY_file_seek(fd, offset, origin);
1408 * \ingroup simix_file_management
1409 * \brief Move a file to another location on the *same mount point*.
1412 int simcall_file_move(smx_file_t fd, const char* fullpath)
1414 return simcall_BODY_file_move(fd, fullpath);
1418 * \ingroup simix_storage_management
1419 * \brief Returns the free space size on a given storage element.
1420 * \param storage a storage
1421 * \return Return the free space size on a given storage element (as sg_size_t)
1423 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1424 return simcall_BODY_storage_get_free_size(storage);
1428 * \ingroup simix_storage_management
1429 * \brief Returns the used space size on a given storage element.
1430 * \param storage a storage
1431 * \return Return the used space size on a given storage element (as sg_size_t)
1433 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1434 return simcall_BODY_storage_get_used_size(storage);
1438 * \ingroup simix_storage_management
1439 * \brief Returns the list of storages mounted on an host.
1440 * \param host A SIMIX host
1441 * \return a dict containing all storages mounted on the host
1443 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
1445 return simcall_BODY_host_get_mounted_storage_list(host);
1449 * \ingroup simix_storage_management
1450 * \brief Returns the list of storages attached to an host.
1451 * \param host A SIMIX host
1452 * \return a dict containing all storages attached to the host
1454 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
1456 return simcall_BODY_host_get_attached_storage_list(host);
1460 * \ingroup simix_storage_management
1461 * \brief Returns a dict of the properties assigned to a storage element.
1463 * \param storage A storage element
1464 * \return The properties of this storage element
1466 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1468 return simcall_BODY_storage_get_properties(storage);
1472 * \ingroup simix_storage_management
1473 * \brief Returns a dict containing the content of a storage element.
1475 * \param storage A storage element
1476 * \return The content of this storage element as a dict (full path file => size)
1478 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1480 return simcall_BODY_storage_get_content(storage);
1487 void *simcall_mc_snapshot(void) {
1488 return simcall_BODY_mc_snapshot();
1491 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1492 return simcall_BODY_mc_compare_snapshots(s1, s2);
1495 #endif /* HAVE_MC */
1497 int simcall_mc_random(int min, int max) {
1498 return simcall_BODY_mc_random(min, max);
1501 /* ************************************************************************** */
1503 /** @brief returns a printable string representing a simcall */
1504 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1505 return simcall_names[kind];