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-2014. The SimGrid Team. All rights reserved. */
10 /* This program is free software; you can redistribute it and/or modify it
11 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "mc/mc_replay.h"
14 #include "smx_private.h"
15 #include "mc/mc_forward.h"
17 #include <math.h> /* isfinite() */
20 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
22 #include "popping_bodies.c"
25 * \ingroup simix_host_management
26 * \brief Returns a host given its name.
28 * \param name The name of the host to get
29 * \return The corresponding host
31 smx_host_t simcall_host_get_by_name(const char *name)
33 return simcall_BODY_host_get_by_name(name);
37 * \ingroup simix_host_management
38 * \brief Returns the name of a host.
40 * \param host A SIMIX host
41 * \return The name of this host
43 const char* simcall_host_get_name(smx_host_t host)
45 return simcall_BODY_host_get_name(host);
49 * \ingroup simix_host_management
50 * \brief Start the host if it is off
52 * \param host A SIMIX host
54 void simcall_host_on(smx_host_t host)
56 simcall_BODY_host_on(host);
60 * \ingroup simix_host_management
61 * \brief Stop the host if it is on
63 * \param host A SIMIX host
65 void simcall_host_off(smx_host_t host)
67 simcall_BODY_host_off(host);
71 * \ingroup simix_host_management
72 * \brief Returns a dict of the properties assigned to a host.
75 * \return The properties of this host
77 xbt_dict_t simcall_host_get_properties(smx_host_t host)
79 return simcall_BODY_host_get_properties(host);
83 * \ingroup simix_host_management
84 * \brief Returns a dict of the properties assigned to a router or AS.
86 * \param name The name of the router or AS
87 * \return The properties
89 xbt_dict_t simcall_asr_get_properties(const char *name)
91 return simcall_BODY_asr_get_properties(name);
96 * \ingroup simix_host_management
97 * \brief Returns the speed of the processor.
99 * The speed returned does not take into account the current load on the machine.
100 * \param host A SIMIX host
101 * \return The speed of this host (in Mflop/s)
103 double simcall_host_get_speed(smx_host_t host)
105 return simcall_BODY_host_get_speed(host);
109 * \ingroup simix_host_management
110 * \brief Returns the number of core of the processor.
112 * \param host A SIMIX host
113 * \return The number of core
115 int simcall_host_get_core(smx_host_t host)
117 return simcall_BODY_host_get_core(host);
121 * \ingroup simix_host_management
122 * \brief Returns the list of processes attached to the host.
124 * \param host A SIMIX host
125 * \return the swag of attached processes
127 xbt_swag_t simcall_host_get_process_list(smx_host_t host)
129 return simcall_BODY_host_get_process_list(host);
134 * \ingroup simix_host_management
135 * \brief Returns the available speed of the processor.
137 * \return Speed currently available (in Mflop/s)
139 double simcall_host_get_available_speed(smx_host_t host)
141 return simcall_BODY_host_get_available_speed(host);
145 * \ingroup simix_host_management
146 * \brief Returns the state of a host.
148 * Two states are possible: 1 if the host is active or 0 if it has crashed.
149 * \param host A SIMIX host
150 * \return 1 if the host is available, 0 otherwise
152 int simcall_host_get_state(smx_host_t host)
154 return simcall_BODY_host_get_state(host);
158 * \ingroup simix_host_management
159 * \brief Returns the power peak of a host.
161 * \param host A SIMIX host
162 * \return the current power peak value (double)
164 double simcall_host_get_current_power_peak(smx_host_t host)
166 return simcall_BODY_host_get_current_power_peak(host);
170 * \ingroup simix_host_management
171 * \brief Returns one power peak (in flops/s) of a host at a given pstate
173 * \param host A SIMIX host
174 * \param pstate_index pstate to test
175 * \return the current power peak value (double) for pstate_index
177 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
179 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
183 * \ingroup simix_host_management
184 * \brief Returns the number of power states for a host.
186 * \param host A SIMIX host
187 * \return the number of power states
189 int simcall_host_get_nb_pstates(smx_host_t host)
191 return simcall_BODY_host_get_nb_pstates(host);
195 * \ingroup simix_host_management
196 * \brief Sets the pstate at which the host should run
198 * \param host A SIMIX host
199 * \param pstate_index The pstate to which the CPU power will be set
201 void simcall_host_set_pstate(smx_host_t host, int pstate_index)
203 simcall_BODY_host_set_pstate(host, pstate_index);
206 * \ingroup simix_host_management
207 * \brief Gets the pstate at which that host currently runs.
209 * \param host A SIMIX host
211 int simcall_host_get_pstate(smx_host_t host)
213 return simcall_BODY_host_get_pstate(host);
217 * \ingroup simix_host_management
218 * \brief Returns the total energy consumed by the host (in Joules)
220 * \param host A SIMIX host
221 * \return the energy consumed by the host (double)
223 double simcall_host_get_consumed_energy(smx_host_t host)
225 return simcall_BODY_host_get_consumed_energy(host);
227 /** \ingroup simix_host_management
228 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
230 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
231 return simcall_BODY_host_get_wattmin_at(host, pstate);
233 /** \ingroup simix_host_management
234 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
236 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
237 return simcall_BODY_host_get_wattmax_at(host, pstate);
243 * \ingroup simix_host_management
244 * \brief Creates a synchro that executes some computation of an host.
246 * This function creates a SURF action and allocates the data necessary
247 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
249 * \param name Name of the execution synchro to create
250 * \param host SIMIX host where the synchro will be executed
251 * \param flops_amount amount Computation amount (in flops)
252 * \param priority computation priority
254 * \param affinity_mask
255 * \return A new SIMIX execution synchronization
257 smx_synchro_t simcall_host_execute(const char *name, smx_host_t host,
259 double priority, double bound, unsigned long affinity_mask)
261 /* checking for infinite values */
262 xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
263 xbt_assert(isfinite(priority), "priority is not finite!");
265 return simcall_BODY_host_execute(name, host, flops_amount, priority, bound, affinity_mask);
269 * \ingroup simix_host_management
270 * \brief Creates a synchro that may involve parallel computation on
271 * several hosts and communication between them.
273 * \param name Name of the execution synchro to create
274 * \param host_nb Number of hosts where the synchro will be executed
275 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
276 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
277 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
278 * amount between each pair of hosts
279 * \param amount the SURF action amount
280 * \param rate the SURF action rate
281 * \return A new SIMIX execution synchronization
283 smx_synchro_t simcall_host_parallel_execute(const char *name,
285 smx_host_t *host_list,
286 double *flops_amount,
287 double *bytes_amount,
292 /* checking for infinite values */
293 for (i = 0 ; i < host_nb ; ++i) {
294 xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
295 for (j = 0 ; j < host_nb ; ++j) {
296 xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
297 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
301 xbt_assert(isfinite(amount), "amount is not finite!");
302 xbt_assert(isfinite(rate), "rate is not finite!");
304 return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
312 * \ingroup simix_host_management
313 * \brief Destroys an execution synchro.
315 * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
316 * \param execution The execution synchro to destroy
318 void simcall_host_execution_destroy(smx_synchro_t execution)
320 simcall_BODY_host_execution_destroy(execution);
324 * \ingroup simix_host_management
325 * \brief Cancels an execution synchro.
327 * This functions stops the execution. It calls a surf function.
328 * \param execution The execution synchro to cancel
330 void simcall_host_execution_cancel(smx_synchro_t execution)
332 simcall_BODY_host_execution_cancel(execution);
336 * \ingroup simix_host_management
337 * \brief Returns how much of an execution synchro remains to be done.
339 * \param execution The execution synchro
340 * \return The remaining amount
342 double simcall_host_execution_get_remains(smx_synchro_t execution)
344 return simcall_BODY_host_execution_get_remains(execution);
348 * \ingroup simix_host_management
349 * \brief Returns the state of an execution synchro.
351 * \param execution The execution synchro
354 e_smx_state_t simcall_host_execution_get_state(smx_synchro_t execution)
356 return simcall_BODY_host_execution_get_state(execution);
360 * \ingroup simix_host_management
361 * \brief Changes the priority of an execution synchro.
363 * This functions changes the priority only. It calls a surf function.
364 * \param execution The execution synchro
365 * \param priority The new priority
367 void simcall_host_execution_set_priority(smx_synchro_t execution, double priority)
369 /* checking for infinite values */
370 xbt_assert(isfinite(priority), "priority is not finite!");
372 simcall_BODY_host_execution_set_priority(execution, priority);
376 * \ingroup simix_host_management
377 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
379 * This functions changes the capping only. It calls a surf function.
380 * \param execution The execution synchro
381 * \param bound The new bound
383 void simcall_host_execution_set_bound(smx_synchro_t execution, double bound)
385 simcall_BODY_host_execution_set_bound(execution, bound);
389 * \ingroup simix_host_management
390 * \brief Changes the CPU affinity of an execution synchro.
392 * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
393 * \param execution The execution synchro
395 * \param mask Affinity mask
397 void simcall_host_execution_set_affinity(smx_synchro_t execution, smx_host_t host, unsigned long mask)
399 simcall_BODY_host_execution_set_affinity(execution, host, mask);
403 * \ingroup simix_host_management
404 * \brief Waits for the completion of an execution synchro and destroy it.
406 * \param execution The execution synchro
408 e_smx_state_t simcall_host_execution_wait(smx_synchro_t execution)
410 return simcall_BODY_host_execution_wait(execution);
415 * \ingroup simix_vm_management
416 * \brief Create a VM on the given physical host.
418 * \param name VM name
419 * \param host Physical host
421 * \return The host object of the VM
423 void* simcall_vm_create(const char *name, smx_host_t phys_host){
424 return simcall_BODY_vm_create(name, phys_host);
428 * \ingroup simix_vm_management
429 * \brief Start the given VM to the given physical host
433 void simcall_vm_start(smx_host_t vm)
435 simcall_BODY_vm_start(vm);
439 * \ingroup simix_vm_management
440 * \brief Get the state of the given VM
443 * \return The state of the VM
445 int simcall_vm_get_state(smx_host_t vm)
447 return simcall_BODY_vm_get_state(vm);
451 * \ingroup simix_vm_management
452 * \brief Get the name of the physical host on which the given VM runs.
455 * \return The name of the physical host
457 void *simcall_vm_get_pm(smx_host_t vm)
459 return simcall_BODY_vm_get_pm(vm);
462 void simcall_vm_set_bound(smx_host_t vm, double bound)
464 simcall_BODY_vm_set_bound(vm, bound);
467 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
469 simcall_BODY_vm_set_affinity(vm, pm, mask);
472 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
474 simcall_BODY_host_get_params(vm, params);
477 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
479 simcall_BODY_host_set_params(vm, params);
483 * \ingroup simix_vm_management
484 * \brief Migrate the given VM to the given physical host
487 * \param host Destination physical host
489 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
491 simcall_BODY_vm_migrate(vm, host);
495 * \ingroup simix_vm_management
496 * \brief Suspend the given VM
500 void simcall_vm_suspend(smx_host_t vm)
502 simcall_BODY_vm_suspend(vm);
506 * \ingroup simix_vm_management
507 * \brief Resume the given VM
511 void simcall_vm_resume(smx_host_t vm)
513 simcall_BODY_vm_resume(vm);
517 * \ingroup simix_vm_management
518 * \brief Save the given VM
522 void simcall_vm_save(smx_host_t vm)
524 simcall_BODY_vm_save(vm);
528 * \ingroup simix_vm_management
529 * \brief Restore the given VM
533 void simcall_vm_restore(smx_host_t vm)
535 simcall_BODY_vm_restore(vm);
539 * \ingroup simix_vm_management
540 * \brief Shutdown the given VM
544 void simcall_vm_shutdown(smx_host_t vm)
546 simcall_BODY_vm_shutdown(vm);
550 * \ingroup simix_vm_management
551 * \brief Destroy the given VM
555 void simcall_vm_destroy(smx_host_t vm)
557 simcall_BODY_vm_destroy(vm);
561 * \ingroup simix_vm_management
562 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
563 * The simcall actually invokes the following calls:
564 * simcall_vm_set_affinity(vm, src_pm, 0);
565 * simcall_vm_migrate(vm, dst_pm);
566 * simcall_vm_resume(vm);
568 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
570 * \param vm VM to migrate
571 * \param src_pm Source physical host
572 * \param dst_pmt Destination physical host
574 void simcall_vm_migratefrom_resumeto(smx_host_t vm, smx_host_t src_pm, smx_host_t dst_pm)
576 simcall_BODY_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
580 * \ingroup simix_process_management
581 * \brief Creates and runs a new SIMIX process.
583 * The structure and the corresponding thread are created and put in the list of ready processes.
585 * \param process the process created will be stored in this pointer
586 * \param name a name for the process. It is for user-level information and can be NULL.
587 * \param code the main function of the process
588 * \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.
589 * It can be retrieved with the function \ref simcall_process_get_data.
590 * \param hostname name of the host where the new agent is executed.
591 * \param kill_time time when the process is killed
592 * \param argc first argument passed to \a code
593 * \param argv second argument passed to \a code
594 * \param properties the properties of the process
595 * \param auto_restart either it is autorestarting or not.
597 void simcall_process_create(smx_process_t *process, const char *name,
598 xbt_main_func_t code,
600 const char *hostname,
602 int argc, char **argv,
603 xbt_dict_t properties,
606 simcall_BODY_process_create(process, name, code, data, hostname,
607 kill_time, argc, argv, properties,
612 * \ingroup simix_process_management
613 * \brief Kills a SIMIX process.
615 * This function simply kills a process.
617 * \param process poor victim
619 void simcall_process_kill(smx_process_t process)
621 simcall_BODY_process_kill(process);
625 * \ingroup simix_process_management
626 * \brief Kills all SIMIX processes.
628 void simcall_process_killall(int reset_pid)
630 simcall_BODY_process_killall(reset_pid);
634 * \ingroup simix_process_management
635 * \brief Cleans up a SIMIX process.
636 * \param process poor victim (must have already been killed)
638 void simcall_process_cleanup(smx_process_t process)
640 simcall_BODY_process_cleanup(process);
644 * \ingroup simix_process_management
645 * \brief Migrates an agent to another location.
647 * This function changes the value of the host on which \a process is running.
649 * \param process the process to migrate
650 * \param dest name of the new host
652 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
654 simcall_BODY_process_change_host(process, dest);
657 void simcall_process_join(smx_process_t process, double timeout)
659 simcall_BODY_process_join(process, timeout);
663 * \ingroup simix_process_management
664 * \brief Suspends a process.
666 * This function suspends the process by suspending the synchro
667 * it was waiting for completion.
669 * \param process a SIMIX process
671 void simcall_process_suspend(smx_process_t process)
673 xbt_assert(process, "Invalid parameters");
675 simcall_BODY_process_suspend(process);
679 * \ingroup simix_process_management
680 * \brief Resumes a suspended process.
682 * This function resumes a suspended process by resuming the synchro
683 * it was waiting for completion.
685 * \param process a SIMIX process
687 void simcall_process_resume(smx_process_t process)
689 simcall_BODY_process_resume(process);
693 * \ingroup simix_process_management
694 * \brief Returns the amount of SIMIX processes in the system
696 * Maestro internal process is not counted, only user code processes are
698 int simcall_process_count(void)
700 return simcall_BODY_process_count();
704 * \ingroup simix_process_management
705 * \brief Return the PID of a #smx_process_t.
706 * \param process a SIMIX process
707 * \return the PID of this process
709 int simcall_process_get_PID(smx_process_t process)
711 if (process == SIMIX_process_self()) {
712 /* avoid a simcall if this function is called by the process itself */
713 return SIMIX_process_get_PID(process);
716 return simcall_BODY_process_get_PID(process);
720 * \ingroup simix_process_management
721 * \brief Return the parent PID of a #smx_process_t.
722 * \param process a SIMIX process
723 * \return the PID of this process parenrt
725 int simcall_process_get_PPID(smx_process_t process)
727 if (process == SIMIX_process_self()) {
728 /* avoid a simcall if this function is called by the process itself */
729 return SIMIX_process_get_PPID(process);
732 return simcall_BODY_process_get_PPID(process);
736 * \ingroup simix_process_management
737 * \brief Return the user data of a #smx_process_t.
738 * \param process a SIMIX process
739 * \return the user data of this process
741 void* simcall_process_get_data(smx_process_t process)
743 if (process == SIMIX_process_self()) {
744 /* avoid a simcall if this function is called by the process itself */
745 return SIMIX_process_get_data(process);
748 return simcall_BODY_process_get_data(process);
752 * \ingroup simix_process_management
753 * \brief Set the user data of a #smx_process_t.
755 * This functions sets the user data associated to \a process.
756 * \param process SIMIX process
757 * \param data User data
759 void simcall_process_set_data(smx_process_t process, void *data)
761 if (process == SIMIX_process_self()) {
762 /* avoid a simcall if this function is called by the process itself */
763 SIMIX_process_self_set_data(process, data);
766 simcall_BODY_process_set_data(process, data);
771 * \ingroup simix_process_management
772 * \brief Set the kill time of a process.
773 * \param process a process
774 * \param kill_time a double
776 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
779 if (kill_time > SIMIX_get_clock()) {
780 if (simix_global->kill_process_function) {
781 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
782 sg_host_name(process->smx_host));
783 process->kill_timer = SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
789 * \ingroup simix_process_management
790 * \brief Return the location on which an agent is running.
792 * This functions returns the smx_host_t corresponding to the location on which
793 * \a process is running.
794 * \param process SIMIX process
797 smx_host_t simcall_process_get_host(smx_process_t process)
799 return simcall_BODY_process_get_host(process);
803 * \ingroup simix_process_management
804 * \brief Return the name of an agent.
806 * This functions checks whether \a process is a valid pointer or not and return its name.
807 * \param process SIMIX process
808 * \return The process name
810 const char* simcall_process_get_name(smx_process_t process)
812 if (process == SIMIX_process_self()) {
813 /* avoid a simcall if this function is called by the process itself */
814 return process->name;
816 return simcall_BODY_process_get_name(process);
820 * \ingroup simix_process_management
821 * \brief Returns true if the process is suspended .
823 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
824 * \param process SIMIX process
825 * \return 1, if the process is suspended, else 0.
827 int simcall_process_is_suspended(smx_process_t process)
829 return simcall_BODY_process_is_suspended(process);
833 * \ingroup simix_process_management
834 * \brief Return the properties
836 * This functions returns the properties associated with this process
838 xbt_dict_t simcall_process_get_properties(smx_process_t process)
840 return simcall_BODY_process_get_properties(process);
843 * \ingroup simix_process_management
844 * \brief Add an on_exit function
845 * Add an on_exit function which will be executed when the process exits/is killed.
847 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
849 simcall_BODY_process_on_exit(process, fun, data);
852 * \ingroup simix_process_management
853 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
854 * Will restart the process when the host comes back up if auto_restart is set to 1.
857 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
859 simcall_BODY_process_auto_restart_set(process, auto_restart);
863 * \ingroup simix_process_management
864 * \brief Restarts the process, killing it and starting it again from scratch.
866 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
868 return simcall_BODY_process_restart(process);
871 * \ingroup simix_process_management
872 * \brief Creates a new sleep SIMIX synchro.
874 * This function creates a SURF action and allocates the data necessary
875 * to create the SIMIX synchro. It can raise a host_error exception if the
876 * host crashed. The default SIMIX name of the synchro is "sleep".
878 * \param duration Time duration of the sleep.
879 * \return A result telling whether the sleep was successful
881 e_smx_state_t simcall_process_sleep(double duration)
883 /* checking for infinite values */
884 xbt_assert(isfinite(duration), "duration is not finite!");
885 return simcall_BODY_process_sleep(duration);
889 * \ingroup simix_rdv_management
890 * \brief Creates a new rendez-vous point
891 * \param name The name of the rendez-vous point
892 * \return The created rendez-vous point
894 smx_rdv_t simcall_rdv_create(const char *name)
896 return simcall_BODY_rdv_create(name);
901 * \ingroup simix_rdv_management
902 * \brief Destroy a rendez-vous point
903 * \param rdv The rendez-vous point to destroy
905 void simcall_rdv_destroy(smx_rdv_t rdv)
907 simcall_BODY_rdv_destroy(rdv);
910 * \ingroup simix_rdv_management
911 * \brief Returns a rendez-vous point knowing its name
913 smx_rdv_t simcall_rdv_get_by_name(const char *name)
915 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
917 /* FIXME: this is a horrible loss of performance, so we hack it out by
918 * skipping the simcall (for now). It works in parallel, it won't work on
919 * distributed but probably we will change MSG for that. */
921 return SIMIX_rdv_get_by_name(name);
925 * \ingroup simix_rdv_management
926 * \brief Counts the number of communication synchros of a given host pending
927 * on a rendez-vous point.
928 * \param rdv The rendez-vous point
929 * \param host The host to be counted
930 * \return The number of comm synchros pending in the rdv
932 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
934 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
938 * \ingroup simix_rdv_management
939 * \brief returns the communication at the head of the rendez-vous
940 * \param rdv The rendez-vous point
941 * \return The communication or NULL if empty
943 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
945 return simcall_BODY_rdv_get_head(rdv);
948 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
950 simcall_BODY_rdv_set_receiver(rdv, process);
953 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
955 return simcall_BODY_rdv_get_receiver(rdv);
959 * \ingroup simix_comm_management
961 void simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
962 void *src_buff, size_t src_buff_size,
963 int (*match_fun)(void *, void *, smx_synchro_t),
964 void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
967 /* checking for infinite values */
968 xbt_assert(isfinite(task_size), "task_size is not finite!");
969 xbt_assert(isfinite(rate), "rate is not finite!");
970 xbt_assert(isfinite(timeout), "timeout is not finite!");
972 xbt_assert(rdv, "No rendez-vous point defined for send");
974 if (MC_is_active() || MC_record_replay_is_active()) {
975 /* the model-checker wants two separate simcalls */
976 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
977 comm = simcall_comm_isend(src, rdv, task_size, rate,
978 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
979 simcall_comm_wait(comm, timeout);
983 simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
984 match_fun, copy_data_fun, data, timeout);
989 * \ingroup simix_comm_management
991 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
992 void *src_buff, size_t src_buff_size,
993 int (*match_fun)(void *, void *, smx_synchro_t),
994 void (*clean_fun)(void *),
995 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
999 /* checking for infinite values */
1000 xbt_assert(isfinite(task_size), "task_size is not finite!");
1001 xbt_assert(isfinite(rate), "rate is not finite!");
1003 xbt_assert(rdv, "No rendez-vous point defined for isend");
1005 return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
1006 src_buff_size, match_fun,
1007 clean_fun, copy_data_fun, data, detached);
1011 * \ingroup simix_comm_management
1013 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
1014 int (*match_fun)(void *, void *, smx_synchro_t),
1015 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1016 void *data, double timeout, double rate)
1018 xbt_assert(isfinite(timeout), "timeout is not finite!");
1019 xbt_assert(rdv, "No rendez-vous point defined for recv");
1021 if (MC_is_active() || MC_record_replay_is_active()) {
1022 /* the model-checker wants two separate simcalls */
1023 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
1024 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
1025 match_fun, copy_data_fun, data, rate);
1026 simcall_comm_wait(comm, timeout);
1030 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
1031 match_fun, copy_data_fun, data, timeout, rate);
1035 * \ingroup simix_comm_management
1037 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1038 int (*match_fun)(void *, void *, smx_synchro_t),
1039 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1040 void *data, double rate)
1042 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1044 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1045 match_fun, copy_data_fun, data, rate);
1049 * \ingroup simix_comm_management
1051 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1052 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1054 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1056 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1060 * \ingroup simix_comm_management
1062 void simcall_comm_cancel(smx_synchro_t comm)
1064 simcall_BODY_comm_cancel(comm);
1068 * \ingroup simix_comm_management
1070 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1072 return simcall_BODY_comm_waitany(comms);
1076 * \ingroup simix_comm_management
1078 int simcall_comm_testany(xbt_dynar_t comms)
1080 if (xbt_dynar_is_empty(comms))
1082 return simcall_BODY_comm_testany(comms);
1086 * \ingroup simix_comm_management
1088 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1090 xbt_assert(isfinite(timeout), "timeout is not finite!");
1091 simcall_BODY_comm_wait(comm, timeout);
1095 * \brief Set the category of an synchro.
1097 * This functions changes the category only. It calls a surf function.
1098 * \param execution The execution synchro
1099 * \param category The tracing category
1101 void simcall_set_category(smx_synchro_t synchro, const char *category)
1103 if (category == NULL) {
1106 simcall_BODY_set_category(synchro, category);
1110 * \ingroup simix_comm_management
1113 int simcall_comm_test(smx_synchro_t comm)
1115 return simcall_BODY_comm_test(comm);
1119 * \ingroup simix_comm_management
1122 double simcall_comm_get_remains(smx_synchro_t comm)
1124 return simcall_BODY_comm_get_remains(comm);
1128 * \ingroup simix_comm_management
1131 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1133 return simcall_BODY_comm_get_state(comm);
1137 * \ingroup simix_comm_management
1140 void *simcall_comm_get_src_data(smx_synchro_t comm)
1142 return simcall_BODY_comm_get_src_data(comm);
1146 * \ingroup simix_comm_management
1149 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1151 return simcall_BODY_comm_get_dst_data(comm);
1155 * \ingroup simix_comm_management
1158 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1160 return simcall_BODY_comm_get_src_proc(comm);
1164 * \ingroup simix_comm_management
1167 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1169 return simcall_BODY_comm_get_dst_proc(comm);
1172 #ifdef HAVE_LATENCY_BOUND_TRACKING
1173 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1175 return simcall_BODY_comm_is_latency_bounded(comm);
1180 * \ingroup simix_synchro_management
1183 smx_mutex_t simcall_mutex_init(void)
1186 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
1189 return simcall_BODY_mutex_init();
1193 * \ingroup simix_synchro_management
1196 void simcall_mutex_destroy(smx_mutex_t mutex)
1198 simcall_BODY_mutex_destroy(mutex);
1202 * \ingroup simix_synchro_management
1205 void simcall_mutex_lock(smx_mutex_t mutex)
1207 simcall_BODY_mutex_lock(mutex);
1211 * \ingroup simix_synchro_management
1214 int simcall_mutex_trylock(smx_mutex_t mutex)
1216 return simcall_BODY_mutex_trylock(mutex);
1220 * \ingroup simix_synchro_management
1223 void simcall_mutex_unlock(smx_mutex_t mutex)
1225 simcall_BODY_mutex_unlock(mutex);
1229 * \ingroup simix_synchro_management
1232 smx_cond_t simcall_cond_init(void)
1234 return simcall_BODY_cond_init();
1238 * \ingroup simix_synchro_management
1241 void simcall_cond_destroy(smx_cond_t cond)
1243 simcall_BODY_cond_destroy(cond);
1247 * \ingroup simix_synchro_management
1250 void simcall_cond_signal(smx_cond_t cond)
1252 simcall_BODY_cond_signal(cond);
1256 * \ingroup simix_synchro_management
1259 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1261 simcall_BODY_cond_wait(cond, mutex);
1265 * \ingroup simix_synchro_management
1268 void simcall_cond_wait_timeout(smx_cond_t cond,
1272 xbt_assert(isfinite(timeout), "timeout is not finite!");
1273 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1277 * \ingroup simix_synchro_management
1280 void simcall_cond_broadcast(smx_cond_t cond)
1282 simcall_BODY_cond_broadcast(cond);
1286 * \ingroup simix_synchro_management
1289 smx_sem_t simcall_sem_init(int capacity)
1291 return simcall_BODY_sem_init(capacity);
1295 * \ingroup simix_synchro_management
1298 void simcall_sem_destroy(smx_sem_t sem)
1300 simcall_BODY_sem_destroy(sem);
1304 * \ingroup simix_synchro_management
1307 void simcall_sem_release(smx_sem_t sem)
1309 simcall_BODY_sem_release(sem);
1313 * \ingroup simix_synchro_management
1316 int simcall_sem_would_block(smx_sem_t sem)
1318 return simcall_BODY_sem_would_block(sem);
1322 * \ingroup simix_synchro_management
1325 void simcall_sem_acquire(smx_sem_t sem)
1327 simcall_BODY_sem_acquire(sem);
1331 * \ingroup simix_synchro_management
1334 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1336 xbt_assert(isfinite(timeout), "timeout is not finite!");
1337 simcall_BODY_sem_acquire_timeout(sem, timeout);
1341 * \ingroup simix_synchro_management
1344 int simcall_sem_get_capacity(smx_sem_t sem)
1346 return simcall_BODY_sem_get_capacity(sem);
1350 * \ingroup simix_file_management
1353 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, smx_host_t host)
1355 return simcall_BODY_file_read(fd, size, host);
1359 * \ingroup simix_file_management
1362 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, smx_host_t host)
1364 return simcall_BODY_file_write(fd, size, host);
1368 * \ingroup simix_file_management
1371 smx_file_t simcall_file_open(const char* fullpath, smx_host_t host)
1373 return simcall_BODY_file_open(fullpath, host);
1377 * \ingroup simix_file_management
1380 int simcall_file_close(smx_file_t fd, smx_host_t host)
1382 return simcall_BODY_file_close(fd, host);
1386 * \ingroup simix_file_management
1389 int simcall_file_unlink(smx_file_t fd, smx_host_t host)
1391 return simcall_BODY_file_unlink(fd, host);
1395 * \ingroup simix_file_management
1398 sg_size_t simcall_file_get_size(smx_file_t fd){
1399 return simcall_BODY_file_get_size(fd);
1403 * \ingroup simix_file_management
1406 sg_size_t simcall_file_tell(smx_file_t fd){
1407 return simcall_BODY_file_tell(fd);
1411 * \ingroup simix_file_management
1414 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1416 return simcall_BODY_file_get_info(fd);
1420 * \ingroup simix_file_management
1423 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1424 return simcall_BODY_file_seek(fd, offset, origin);
1428 * \ingroup simix_file_management
1429 * \brief Move a file to another location on the *same mount point*.
1432 int simcall_file_move(smx_file_t fd, const char* fullpath)
1434 return simcall_BODY_file_move(fd, fullpath);
1438 * \ingroup simix_storage_management
1439 * \brief Returns the free space size on a given storage element.
1440 * \param storage a storage
1441 * \return Return the free space size on a given storage element (as sg_size_t)
1443 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1444 return simcall_BODY_storage_get_free_size(storage);
1448 * \ingroup simix_storage_management
1449 * \brief Returns the used space size on a given storage element.
1450 * \param storage a storage
1451 * \return Return the used space size on a given storage element (as sg_size_t)
1453 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1454 return simcall_BODY_storage_get_used_size(storage);
1458 * \ingroup simix_storage_management
1459 * \brief Returns the list of storages mounted on an host.
1460 * \param host A SIMIX host
1461 * \return a dict containing all storages mounted on the host
1463 xbt_dict_t simcall_host_get_mounted_storage_list(smx_host_t host)
1465 return simcall_BODY_host_get_mounted_storage_list(host);
1469 * \ingroup simix_storage_management
1470 * \brief Returns the list of storages attached to an host.
1471 * \param host A SIMIX host
1472 * \return a dict containing all storages attached to the host
1474 xbt_dynar_t simcall_host_get_attached_storage_list(smx_host_t host)
1476 return simcall_BODY_host_get_attached_storage_list(host);
1480 * \ingroup simix_storage_management
1481 * \brief Returns a dict of the properties assigned to a storage element.
1483 * \param storage A storage element
1484 * \return The properties of this storage element
1486 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1488 return simcall_BODY_storage_get_properties(storage);
1492 * \ingroup simix_storage_management
1493 * \brief Returns a dict containing the content of a storage element.
1495 * \param storage A storage element
1496 * \return The content of this storage element as a dict (full path file => size)
1498 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1500 return simcall_BODY_storage_get_content(storage);
1507 void *simcall_mc_snapshot(void) {
1508 return simcall_BODY_mc_snapshot();
1511 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1512 return simcall_BODY_mc_compare_snapshots(s1, s2);
1515 #endif /* HAVE_MC */
1517 int simcall_mc_random(int min, int max) {
1518 return simcall_BODY_mc_random(min, max);
1521 /* ************************************************************************** */
1523 /** @brief returns a printable string representing a simcall */
1524 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1525 return simcall_names[kind];