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 "mc/mc_replay.h"
15 #include "smx_private.h"
16 #include "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 Returns the name of a host.
29 * \param host A SIMIX host
30 * \return The name of this host
32 const char* simcall_host_get_name(sg_host_t host)
34 return simcall_BODY_host_get_name(host);
38 * \ingroup simix_host_management
39 * \brief Start the host if it is off
41 * \param host A SIMIX host
43 void simcall_host_on(sg_host_t host)
45 simcall_BODY_host_on(host);
49 * \ingroup simix_host_management
50 * \brief Stop the host if it is on
52 * \param host A SIMIX host
54 void simcall_host_off(sg_host_t host)
56 simcall_BODY_host_off(host);
60 * \ingroup simix_host_management
61 * \brief Returns a dict of the properties assigned to a host.
64 * \return The properties of this host
66 xbt_dict_t simcall_host_get_properties(sg_host_t host)
68 return simcall_BODY_host_get_properties(host);
72 * \ingroup simix_host_management
73 * \brief Returns a dict of the properties assigned to a router or AS.
75 * \param name The name of the router or AS
76 * \return The properties
78 xbt_dict_t simcall_asr_get_properties(const char *name)
80 return simcall_BODY_asr_get_properties(name);
85 * \ingroup simix_host_management
86 * \brief Returns the speed of the processor.
88 * The speed returned does not take into account the current load on the machine.
89 * \param host A SIMIX host
90 * \return The speed of this host (in Mflop/s)
92 double simcall_host_get_speed(sg_host_t host)
94 return simcall_BODY_host_get_speed(host);
98 * \ingroup simix_host_management
99 * \brief Returns the number of core of the processor.
101 * \param host A SIMIX host
102 * \return The number of core
104 int simcall_host_get_core(sg_host_t host)
106 return simcall_BODY_host_get_core(host);
110 * \ingroup simix_host_management
111 * \brief Returns the list of processes attached to the host.
113 * \param host A SIMIX host
114 * \return the swag of attached processes
116 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
118 return simcall_BODY_host_get_process_list(host);
123 * \ingroup simix_host_management
124 * \brief Returns the available speed of the processor.
126 * \return Speed currently available (in Mflop/s)
128 double simcall_host_get_available_speed(sg_host_t host)
130 return simcall_BODY_host_get_available_speed(host);
134 * \ingroup simix_host_management
135 * \brief Returns the state of a host.
137 * Two states are possible: 1 if the host is active or 0 if it has crashed.
138 * \param host A SIMIX host
139 * \return 1 if the host is available, 0 otherwise
141 int simcall_host_get_state(sg_host_t host)
143 return simcall_BODY_host_get_state(host);
147 * \ingroup simix_host_management
148 * \brief Returns the power peak of a host.
150 * \param host A SIMIX host
151 * \return the current power peak value (double)
153 double simcall_host_get_current_power_peak(sg_host_t host)
155 return simcall_BODY_host_get_current_power_peak(host);
159 * \ingroup simix_host_management
160 * \brief Returns one power peak (in flops/s) of a host at a given pstate
162 * \param host A SIMIX host
163 * \param pstate_index pstate to test
164 * \return the current power peak value (double) for pstate_index
166 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
168 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
172 * \ingroup simix_host_management
173 * \brief Returns the number of power states for a host.
175 * \param host A SIMIX host
176 * \return the number of power states
178 int simcall_host_get_nb_pstates(sg_host_t host)
180 return simcall_BODY_host_get_nb_pstates(host);
184 * \ingroup simix_host_management
185 * \brief Sets the pstate at which the host should run
187 * \param host A SIMIX host
188 * \param pstate_index The pstate to which the CPU power will be set
190 void simcall_host_set_pstate(sg_host_t host, int pstate_index)
192 simcall_BODY_host_set_pstate(host, pstate_index);
195 * \ingroup simix_host_management
196 * \brief Gets the pstate at which that host currently runs.
198 * \param host A SIMIX host
200 int simcall_host_get_pstate(sg_host_t host)
202 return simcall_BODY_host_get_pstate(host);
206 * \ingroup simix_host_management
207 * \brief Returns the total energy consumed by the host (in Joules)
209 * \param host A SIMIX host
210 * \return the energy consumed by the host (double)
212 double simcall_host_get_consumed_energy(sg_host_t host)
214 return simcall_BODY_host_get_consumed_energy(host);
216 /** \ingroup simix_host_management
217 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
219 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
220 return simcall_BODY_host_get_wattmin_at(host, pstate);
222 /** \ingroup simix_host_management
223 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
225 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
226 return simcall_BODY_host_get_wattmax_at(host, pstate);
232 * \ingroup simix_process_management
233 * \brief Creates a synchro that executes some computation of an host.
235 * This function creates a SURF action and allocates the data necessary
236 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
238 * \param name Name of the execution synchro to create
239 * \param flops_amount amount Computation amount (in flops)
240 * \param priority computation priority
242 * \param affinity_mask
243 * \return A new SIMIX execution synchronization
245 smx_synchro_t simcall_process_execute(const char *name,
247 double priority, double bound, unsigned long affinity_mask)
249 /* checking for infinite values */
250 xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
251 xbt_assert(isfinite(priority), "priority is not finite!");
253 return simcall_BODY_process_execute(name, flops_amount, priority, bound, affinity_mask);
257 * \ingroup simix_process_management
258 * \brief Creates a synchro that may involve parallel computation on
259 * several hosts and communication between them.
261 * \param name Name of the execution synchro to create
262 * \param host_nb Number of hosts where the synchro will be executed
263 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
264 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
265 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
266 * amount between each pair of hosts
267 * \param amount the SURF action amount
268 * \param rate the SURF action rate
269 * \return A new SIMIX execution synchronization
271 smx_synchro_t simcall_process_parallel_execute(const char *name,
273 sg_host_t *host_list,
274 double *flops_amount,
275 double *bytes_amount,
280 /* checking for infinite values */
281 for (i = 0 ; i < host_nb ; ++i) {
282 xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
283 for (j = 0 ; j < host_nb ; ++j) {
284 xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
285 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
289 xbt_assert(isfinite(amount), "amount is not finite!");
290 xbt_assert(isfinite(rate), "rate is not finite!");
292 return simcall_BODY_process_parallel_execute(name, host_nb, host_list,
300 * \ingroup simix_process_management
301 * \brief Destroys an execution synchro.
303 * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
304 * \param execution The execution synchro to destroy
306 void simcall_process_execution_destroy(smx_synchro_t execution)
308 simcall_BODY_process_execution_destroy(execution);
312 * \ingroup simix_process_management
313 * \brief Cancels an execution synchro.
315 * This functions stops the execution. It calls a surf function.
316 * \param execution The execution synchro to cancel
318 void simcall_process_execution_cancel(smx_synchro_t execution)
320 simcall_BODY_process_execution_cancel(execution);
324 * \ingroup simix_process_management
325 * \brief Returns how much of an execution synchro remains to be done.
327 * \param execution The execution synchro
328 * \return The remaining amount
330 double simcall_process_execution_get_remains(smx_synchro_t execution)
332 return simcall_BODY_process_execution_get_remains(execution);
336 * \ingroup simix_process_management
337 * \brief Returns the state of an execution synchro.
339 * \param execution The execution synchro
342 e_smx_state_t simcall_process_execution_get_state(smx_synchro_t execution)
344 return simcall_BODY_process_execution_get_state(execution);
348 * \ingroup simix_process_management
349 * \brief Changes the priority of an execution synchro.
351 * This functions changes the priority only. It calls a surf function.
352 * \param execution The execution synchro
353 * \param priority The new priority
355 void simcall_process_execution_set_priority(smx_synchro_t execution, double priority)
357 /* checking for infinite values */
358 xbt_assert(isfinite(priority), "priority is not finite!");
360 simcall_BODY_process_execution_set_priority(execution, priority);
364 * \ingroup simix_process_management
365 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
367 * This functions changes the capping only. It calls a surf function.
368 * \param execution The execution synchro
369 * \param bound The new bound
371 void simcall_process_execution_set_bound(smx_synchro_t execution, double bound)
373 simcall_BODY_process_execution_set_bound(execution, bound);
377 * \ingroup simix_process_management
378 * \brief Changes the CPU affinity of an execution synchro.
380 * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
381 * \param execution The execution synchro
383 * \param mask Affinity mask
385 void simcall_process_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
387 simcall_BODY_process_execution_set_affinity(execution, host, mask);
391 * \ingroup simix_host_management
392 * \brief Waits for the completion of an execution synchro and destroy it.
394 * \param execution The execution synchro
396 e_smx_state_t simcall_process_execution_wait(smx_synchro_t execution)
398 return simcall_BODY_process_execution_wait(execution);
403 * \ingroup simix_vm_management
404 * \brief Create a VM on the given physical host.
406 * \param name VM name
407 * \param host Physical host
409 * \return The host object of the VM
411 void* simcall_vm_create(const char *name, sg_host_t phys_host){
412 return simcall_BODY_vm_create(name, phys_host);
416 * \ingroup simix_vm_management
417 * \brief Start the given VM to the given physical host
421 void simcall_vm_start(sg_host_t vm)
423 simcall_BODY_vm_start(vm);
427 * \ingroup simix_vm_management
428 * \brief Get the state of the given VM
431 * \return The state of the VM
433 int simcall_vm_get_state(sg_host_t vm)
435 return simcall_BODY_vm_get_state(vm);
439 * \ingroup simix_vm_management
440 * \brief Get the name of the physical host on which the given VM runs.
443 * \return The name of the physical host
445 void *simcall_vm_get_pm(sg_host_t vm)
447 return simcall_BODY_vm_get_pm(vm);
450 void simcall_vm_set_bound(sg_host_t vm, double bound)
452 simcall_BODY_vm_set_bound(vm, bound);
455 void simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask)
457 simcall_BODY_vm_set_affinity(vm, pm, mask);
460 void simcall_host_get_params(sg_host_t vm, vm_params_t params)
462 simcall_BODY_host_get_params(vm, params);
465 void simcall_host_set_params(sg_host_t vm, vm_params_t params)
467 simcall_BODY_host_set_params(vm, params);
471 * \ingroup simix_vm_management
472 * \brief Migrate the given VM to the given physical host
475 * \param host Destination physical host
477 void simcall_vm_migrate(sg_host_t vm, sg_host_t host)
479 simcall_BODY_vm_migrate(vm, host);
483 * \ingroup simix_vm_management
484 * \brief Suspend the given VM
488 void simcall_vm_suspend(sg_host_t vm)
490 simcall_BODY_vm_suspend(vm);
494 * \ingroup simix_vm_management
495 * \brief Resume the given VM
499 void simcall_vm_resume(sg_host_t vm)
501 simcall_BODY_vm_resume(vm);
505 * \ingroup simix_vm_management
506 * \brief Save the given VM
510 void simcall_vm_save(sg_host_t vm)
512 simcall_BODY_vm_save(vm);
516 * \ingroup simix_vm_management
517 * \brief Restore the given VM
521 void simcall_vm_restore(sg_host_t vm)
523 simcall_BODY_vm_restore(vm);
527 * \ingroup simix_vm_management
528 * \brief Shutdown the given VM
532 void simcall_vm_shutdown(sg_host_t vm)
534 simcall_BODY_vm_shutdown(vm);
538 * \ingroup simix_vm_management
539 * \brief Destroy the given VM
543 void simcall_vm_destroy(sg_host_t vm)
545 simcall_BODY_vm_destroy(vm);
549 * \ingroup simix_vm_management
550 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
551 * The simcall actually invokes the following calls:
552 * simcall_vm_set_affinity(vm, src_pm, 0);
553 * simcall_vm_migrate(vm, dst_pm);
554 * simcall_vm_resume(vm);
556 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
558 * \param vm VM to migrate
559 * \param src_pm Source physical host
560 * \param dst_pmt Destination physical host
562 void simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
564 simcall_BODY_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
568 * \ingroup simix_process_management
569 * \brief Creates and runs a new SIMIX process.
571 * The structure and the corresponding thread are created and put in the list of ready processes.
573 * \param name a name for the process. It is for user-level information and can be NULL.
574 * \param code the main function of the process
575 * \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.
576 * It can be retrieved with the function \ref simcall_process_get_data.
577 * \param hostname name of the host where the new agent is executed.
578 * \param kill_time time when the process is killed
579 * \param argc first argument passed to \a code
580 * \param argv second argument passed to \a code
581 * \param properties the properties of the process
582 * \param auto_restart either it is autorestarting or not.
584 smx_process_t simcall_process_create(const char *name,
585 xbt_main_func_t code,
587 const char *hostname,
589 int argc, char **argv,
590 xbt_dict_t properties,
593 return (smx_process_t) simcall_BODY_process_create(name, code, data, hostname,
594 kill_time, argc, argv, properties,
599 * \ingroup simix_process_management
600 * \brief Kills a SIMIX process.
602 * This function simply kills a process.
604 * \param process poor victim
606 void simcall_process_kill(smx_process_t process)
608 simcall_BODY_process_kill(process);
612 * \ingroup simix_process_management
613 * \brief Kills all SIMIX processes.
615 void simcall_process_killall(int reset_pid)
617 simcall_BODY_process_killall(reset_pid);
621 * \ingroup simix_process_management
622 * \brief Cleans up a SIMIX process.
623 * \param process poor victim (must have already been killed)
625 void simcall_process_cleanup(smx_process_t process)
627 simcall_BODY_process_cleanup(process);
631 * \ingroup simix_process_management
632 * \brief Migrates an agent to another location.
634 * This function changes the value of the host on which \a process is running.
636 * \param process the process to migrate
637 * \param dest name of the new host
639 void simcall_process_change_host(smx_process_t process, sg_host_t dest)
641 simcall_BODY_process_change_host(process, dest);
644 void simcall_process_join(smx_process_t process, double timeout)
646 simcall_BODY_process_join(process, timeout);
650 * \ingroup simix_process_management
651 * \brief Suspends a process.
653 * This function suspends the process by suspending the synchro
654 * it was waiting for completion.
656 * \param process a SIMIX process
658 void simcall_process_suspend(smx_process_t process)
660 xbt_assert(process, "Invalid parameters");
662 simcall_BODY_process_suspend(process);
666 * \ingroup simix_process_management
667 * \brief Resumes a suspended process.
669 * This function resumes a suspended process by resuming the synchro
670 * it was waiting for completion.
672 * \param process a SIMIX process
674 void simcall_process_resume(smx_process_t process)
676 simcall_BODY_process_resume(process);
680 * \ingroup simix_process_management
681 * \brief Returns the amount of SIMIX processes in the system
683 * Maestro internal process is not counted, only user code processes are
685 int simcall_process_count(void)
687 return simcall_BODY_process_count();
691 * \ingroup simix_process_management
692 * \brief Return the PID of a #smx_process_t.
693 * \param process a SIMIX process
694 * \return the PID of this process
696 int simcall_process_get_PID(smx_process_t process)
698 if (process == SIMIX_process_self()) {
699 /* avoid a simcall if this function is called by the process itself */
700 return SIMIX_process_get_PID(process);
703 return simcall_BODY_process_get_PID(process);
707 * \ingroup simix_process_management
708 * \brief Return the parent PID of a #smx_process_t.
709 * \param process a SIMIX process
710 * \return the PID of this process parenrt
712 int simcall_process_get_PPID(smx_process_t process)
714 if (process == SIMIX_process_self()) {
715 /* avoid a simcall if this function is called by the process itself */
716 return SIMIX_process_get_PPID(process);
719 return simcall_BODY_process_get_PPID(process);
723 * \ingroup simix_process_management
724 * \brief Return the user data of a #smx_process_t.
725 * \param process a SIMIX process
726 * \return the user data of this process
728 void* simcall_process_get_data(smx_process_t process)
730 if (process == SIMIX_process_self()) {
731 /* avoid a simcall if this function is called by the process itself */
732 return SIMIX_process_get_data(process);
735 return simcall_BODY_process_get_data(process);
739 * \ingroup simix_process_management
740 * \brief Set the user data of a #smx_process_t.
742 * This functions sets the user data associated to \a process.
743 * \param process SIMIX process
744 * \param data User data
746 void simcall_process_set_data(smx_process_t process, void *data)
748 if (process == SIMIX_process_self()) {
749 /* avoid a simcall if this function is called by the process itself */
750 SIMIX_process_self_set_data(process, data);
753 simcall_BODY_process_set_data(process, data);
758 * \ingroup simix_process_management
759 * \brief Set the kill time of a process.
761 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
764 if (kill_time > SIMIX_get_clock()) {
765 if (simix_global->kill_process_function) {
766 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
767 sg_host_name(process->host));
768 process->kill_timer = SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
773 * \ingroup simix_process_management
774 * \brief Get the kill time of a process (or 0 if unset).
776 double simcall_process_get_kill_time(smx_process_t process) {
777 return SIMIX_timer_get_date(process->kill_timer);
781 * \ingroup simix_process_management
782 * \brief Return the location on which an agent is running.
784 * This functions returns the sg_host_t corresponding to the location on which
785 * \a process is running.
786 * \param process SIMIX process
789 sg_host_t simcall_process_get_host(smx_process_t process)
791 return simcall_BODY_process_get_host(process);
795 * \ingroup simix_process_management
796 * \brief Return the name of an agent.
798 * This functions checks whether \a process is a valid pointer or not and return its name.
799 * \param process SIMIX process
800 * \return The process name
802 const char* simcall_process_get_name(smx_process_t process)
804 if (process == SIMIX_process_self()) {
805 /* avoid a simcall if this function is called by the process itself */
806 return process->name;
808 return simcall_BODY_process_get_name(process);
812 * \ingroup simix_process_management
813 * \brief Returns true if the process is suspended .
815 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
816 * \param process SIMIX process
817 * \return 1, if the process is suspended, else 0.
819 int simcall_process_is_suspended(smx_process_t process)
821 return simcall_BODY_process_is_suspended(process);
825 * \ingroup simix_process_management
826 * \brief Return the properties
828 * This functions returns the properties associated with this process
830 xbt_dict_t simcall_process_get_properties(smx_process_t process)
832 return simcall_BODY_process_get_properties(process);
835 * \ingroup simix_process_management
836 * \brief Add an on_exit function
837 * Add an on_exit function which will be executed when the process exits/is killed.
839 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
841 simcall_BODY_process_on_exit(process, fun, data);
844 * \ingroup simix_process_management
845 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
846 * Will restart the process when the host comes back up if auto_restart is set to 1.
849 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
851 simcall_BODY_process_auto_restart_set(process, auto_restart);
855 * \ingroup simix_process_management
856 * \brief Restarts the process, killing it and starting it again from scratch.
858 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
860 return simcall_BODY_process_restart(process);
863 * \ingroup simix_process_management
864 * \brief Creates a new sleep SIMIX synchro.
866 * This function creates a SURF action and allocates the data necessary
867 * to create the SIMIX synchro. It can raise a host_error exception if the
868 * host crashed. The default SIMIX name of the synchro is "sleep".
870 * \param duration Time duration of the sleep.
871 * \return A result telling whether the sleep was successful
873 e_smx_state_t simcall_process_sleep(double duration)
875 /* checking for infinite values */
876 xbt_assert(isfinite(duration), "duration is not finite!");
877 return simcall_BODY_process_sleep(duration);
881 * \ingroup simix_rdv_management
882 * \brief Creates a new rendez-vous point
883 * \param name The name of the rendez-vous point
884 * \return The created rendez-vous point
886 smx_rdv_t simcall_rdv_create(const char *name)
888 return simcall_BODY_rdv_create(name);
893 * \ingroup simix_rdv_management
894 * \brief Destroy a rendez-vous point
895 * \param rdv The rendez-vous point to destroy
897 void simcall_rdv_destroy(smx_rdv_t rdv)
899 simcall_BODY_rdv_destroy(rdv);
902 * \ingroup simix_rdv_management
903 * \brief Returns a rendez-vous point knowing its name
905 smx_rdv_t simcall_rdv_get_by_name(const char *name)
907 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
909 /* FIXME: this is a horrible loss of performance, so we hack it out by
910 * skipping the simcall (for now). It works in parallel, it won't work on
911 * distributed but probably we will change MSG for that. */
913 return SIMIX_rdv_get_by_name(name);
917 * \ingroup simix_rdv_management
918 * \brief Counts the number of communication synchros of a given host pending
919 * on a rendez-vous point.
920 * \param rdv The rendez-vous point
921 * \param host The host to be counted
922 * \return The number of comm synchros pending in the rdv
924 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
926 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
930 * \ingroup simix_rdv_management
931 * \brief returns the communication at the head of the rendez-vous
932 * \param rdv The rendez-vous point
933 * \return The communication or NULL if empty
935 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
937 return simcall_BODY_rdv_get_head(rdv);
940 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
942 simcall_BODY_rdv_set_receiver(rdv, process);
945 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
947 return simcall_BODY_rdv_get_receiver(rdv);
951 * \ingroup simix_comm_management
953 void simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
954 void *src_buff, size_t src_buff_size,
955 int (*match_fun)(void *, void *, smx_synchro_t),
956 void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
959 /* checking for infinite values */
960 xbt_assert(isfinite(task_size), "task_size is not finite!");
961 xbt_assert(isfinite(rate), "rate is not finite!");
962 xbt_assert(isfinite(timeout), "timeout is not finite!");
964 xbt_assert(rdv, "No rendez-vous point defined for send");
966 if (MC_is_active() || MC_record_replay_is_active()) {
967 /* the model-checker wants two separate simcalls */
968 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
969 comm = simcall_comm_isend(src, rdv, task_size, rate,
970 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
971 simcall_comm_wait(comm, timeout);
975 simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
976 match_fun, copy_data_fun, data, timeout);
981 * \ingroup simix_comm_management
983 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
984 void *src_buff, size_t src_buff_size,
985 int (*match_fun)(void *, void *, smx_synchro_t),
986 void (*clean_fun)(void *),
987 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
991 /* checking for infinite values */
992 xbt_assert(isfinite(task_size), "task_size is not finite!");
993 xbt_assert(isfinite(rate), "rate is not finite!");
995 xbt_assert(rdv, "No rendez-vous point defined for isend");
997 return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
998 src_buff_size, match_fun,
999 clean_fun, copy_data_fun, data, detached);
1003 * \ingroup simix_comm_management
1005 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
1006 int (*match_fun)(void *, void *, smx_synchro_t),
1007 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1008 void *data, double timeout, double rate)
1010 xbt_assert(isfinite(timeout), "timeout is not finite!");
1011 xbt_assert(rdv, "No rendez-vous point defined for recv");
1013 if (MC_is_active() || MC_record_replay_is_active()) {
1014 /* the model-checker wants two separate simcalls */
1015 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
1016 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
1017 match_fun, copy_data_fun, data, rate);
1018 simcall_comm_wait(comm, timeout);
1022 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
1023 match_fun, copy_data_fun, data, timeout, rate);
1027 * \ingroup simix_comm_management
1029 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1030 int (*match_fun)(void *, void *, smx_synchro_t),
1031 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1032 void *data, double rate)
1034 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1036 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1037 match_fun, copy_data_fun, data, rate);
1041 * \ingroup simix_comm_management
1043 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1044 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1046 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1048 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1052 * \ingroup simix_comm_management
1054 void simcall_comm_cancel(smx_synchro_t comm)
1056 simcall_BODY_comm_cancel(comm);
1060 * \ingroup simix_comm_management
1062 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1064 return simcall_BODY_comm_waitany(comms);
1068 * \ingroup simix_comm_management
1070 int simcall_comm_testany(xbt_dynar_t comms)
1072 if (xbt_dynar_is_empty(comms))
1074 return simcall_BODY_comm_testany(comms);
1078 * \ingroup simix_comm_management
1080 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1082 xbt_assert(isfinite(timeout), "timeout is not finite!");
1083 simcall_BODY_comm_wait(comm, timeout);
1087 * \brief Set the category of an synchro.
1089 * This functions changes the category only. It calls a surf function.
1090 * \param execution The execution synchro
1091 * \param category The tracing category
1093 void simcall_set_category(smx_synchro_t synchro, const char *category)
1095 if (category == NULL) {
1098 simcall_BODY_set_category(synchro, category);
1102 * \ingroup simix_comm_management
1105 int simcall_comm_test(smx_synchro_t comm)
1107 return simcall_BODY_comm_test(comm);
1111 * \ingroup simix_comm_management
1114 double simcall_comm_get_remains(smx_synchro_t comm)
1116 return simcall_BODY_comm_get_remains(comm);
1120 * \ingroup simix_comm_management
1123 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1125 return simcall_BODY_comm_get_state(comm);
1129 * \ingroup simix_comm_management
1132 void *simcall_comm_get_src_data(smx_synchro_t comm)
1134 return simcall_BODY_comm_get_src_data(comm);
1138 * \ingroup simix_comm_management
1141 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1143 return simcall_BODY_comm_get_dst_data(comm);
1147 * \ingroup simix_comm_management
1150 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1152 return simcall_BODY_comm_get_src_proc(comm);
1156 * \ingroup simix_comm_management
1159 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1161 return simcall_BODY_comm_get_dst_proc(comm);
1164 #ifdef HAVE_LATENCY_BOUND_TRACKING
1165 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1167 return simcall_BODY_comm_is_latency_bounded(comm);
1172 * \ingroup simix_synchro_management
1175 smx_mutex_t simcall_mutex_init(void)
1178 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
1181 return simcall_BODY_mutex_init();
1185 * \ingroup simix_synchro_management
1188 void simcall_mutex_destroy(smx_mutex_t mutex)
1190 simcall_BODY_mutex_destroy(mutex);
1194 * \ingroup simix_synchro_management
1197 void simcall_mutex_lock(smx_mutex_t mutex)
1199 simcall_BODY_mutex_lock(mutex);
1203 * \ingroup simix_synchro_management
1206 int simcall_mutex_trylock(smx_mutex_t mutex)
1208 return simcall_BODY_mutex_trylock(mutex);
1212 * \ingroup simix_synchro_management
1215 void simcall_mutex_unlock(smx_mutex_t mutex)
1217 simcall_BODY_mutex_unlock(mutex);
1221 * \ingroup simix_synchro_management
1224 smx_cond_t simcall_cond_init(void)
1226 return simcall_BODY_cond_init();
1230 * \ingroup simix_synchro_management
1233 void simcall_cond_destroy(smx_cond_t cond)
1235 simcall_BODY_cond_destroy(cond);
1239 * \ingroup simix_synchro_management
1242 void simcall_cond_signal(smx_cond_t cond)
1244 simcall_BODY_cond_signal(cond);
1248 * \ingroup simix_synchro_management
1251 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1253 simcall_BODY_cond_wait(cond, mutex);
1257 * \ingroup simix_synchro_management
1260 void simcall_cond_wait_timeout(smx_cond_t cond,
1264 xbt_assert(isfinite(timeout), "timeout is not finite!");
1265 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1269 * \ingroup simix_synchro_management
1272 void simcall_cond_broadcast(smx_cond_t cond)
1274 simcall_BODY_cond_broadcast(cond);
1278 * \ingroup simix_synchro_management
1281 smx_sem_t simcall_sem_init(int capacity)
1283 return simcall_BODY_sem_init(capacity);
1287 * \ingroup simix_synchro_management
1290 void simcall_sem_destroy(smx_sem_t sem)
1292 simcall_BODY_sem_destroy(sem);
1296 * \ingroup simix_synchro_management
1299 void simcall_sem_release(smx_sem_t sem)
1301 simcall_BODY_sem_release(sem);
1305 * \ingroup simix_synchro_management
1308 int simcall_sem_would_block(smx_sem_t sem)
1310 return simcall_BODY_sem_would_block(sem);
1314 * \ingroup simix_synchro_management
1317 void simcall_sem_acquire(smx_sem_t sem)
1319 simcall_BODY_sem_acquire(sem);
1323 * \ingroup simix_synchro_management
1326 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1328 xbt_assert(isfinite(timeout), "timeout is not finite!");
1329 simcall_BODY_sem_acquire_timeout(sem, timeout);
1333 * \ingroup simix_synchro_management
1336 int simcall_sem_get_capacity(smx_sem_t sem)
1338 return simcall_BODY_sem_get_capacity(sem);
1342 * \ingroup simix_file_management
1345 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1347 return simcall_BODY_file_read(fd, size, host);
1351 * \ingroup simix_file_management
1354 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1356 return simcall_BODY_file_write(fd, size, host);
1360 * \ingroup simix_file_management
1363 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1365 return simcall_BODY_file_open(fullpath, host);
1369 * \ingroup simix_file_management
1372 int simcall_file_close(smx_file_t fd, sg_host_t host)
1374 return simcall_BODY_file_close(fd, host);
1378 * \ingroup simix_file_management
1381 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1383 return simcall_BODY_file_unlink(fd, host);
1387 * \ingroup simix_file_management
1390 sg_size_t simcall_file_get_size(smx_file_t fd){
1391 return simcall_BODY_file_get_size(fd);
1395 * \ingroup simix_file_management
1398 sg_size_t simcall_file_tell(smx_file_t fd){
1399 return simcall_BODY_file_tell(fd);
1403 * \ingroup simix_file_management
1406 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1408 return simcall_BODY_file_get_info(fd);
1412 * \ingroup simix_file_management
1415 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1416 return simcall_BODY_file_seek(fd, offset, origin);
1420 * \ingroup simix_file_management
1421 * \brief Move a file to another location on the *same mount point*.
1424 int simcall_file_move(smx_file_t fd, const char* fullpath)
1426 return simcall_BODY_file_move(fd, fullpath);
1430 * \ingroup simix_storage_management
1431 * \brief Returns the free space size on a given storage element.
1432 * \param storage a storage
1433 * \return Return the free space size on a given storage element (as sg_size_t)
1435 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1436 return simcall_BODY_storage_get_free_size(storage);
1440 * \ingroup simix_storage_management
1441 * \brief Returns the used space size on a given storage element.
1442 * \param storage a storage
1443 * \return Return the used space size on a given storage element (as sg_size_t)
1445 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1446 return simcall_BODY_storage_get_used_size(storage);
1450 * \ingroup simix_storage_management
1451 * \brief Returns the list of storages mounted on an host.
1452 * \param host A SIMIX host
1453 * \return a dict containing all storages mounted on the host
1455 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
1457 return simcall_BODY_host_get_mounted_storage_list(host);
1461 * \ingroup simix_storage_management
1462 * \brief Returns the list of storages attached to an host.
1463 * \param host A SIMIX host
1464 * \return a dict containing all storages attached to the host
1466 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
1468 return simcall_BODY_host_get_attached_storage_list(host);
1472 * \ingroup simix_storage_management
1473 * \brief Returns a dict of the properties assigned to a storage element.
1475 * \param storage A storage element
1476 * \return The properties of this storage element
1478 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1480 return simcall_BODY_storage_get_properties(storage);
1484 * \ingroup simix_storage_management
1485 * \brief Returns a dict containing the content of a storage element.
1487 * \param storage A storage element
1488 * \return The content of this storage element as a dict (full path file => size)
1490 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1492 return simcall_BODY_storage_get_content(storage);
1499 void *simcall_mc_snapshot(void) {
1500 return simcall_BODY_mc_snapshot();
1503 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1504 return simcall_BODY_mc_compare_snapshots(s1, s2);
1507 #endif /* HAVE_MC */
1509 int simcall_mc_random(int min, int max) {
1510 return simcall_BODY_mc_random(min, max);
1513 /* ************************************************************************** */
1515 /** @brief returns a printable string representing a simcall */
1516 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1517 return simcall_names[kind];