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_interface.h"
17 #include <math.h> /* isfinite() */
19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
21 #include "popping_bodies.c"
24 * \ingroup simix_host_management
25 * \brief Returns a host given its name.
27 * \param name The name of the host to get
28 * \return The corresponding host
30 smx_host_t simcall_host_get_by_name(const char *name)
32 return simcall_BODY_host_get_by_name(name);
36 * \ingroup simix_host_management
37 * \brief Returns the name of a host.
39 * \param host A SIMIX host
40 * \return The name of this host
42 const char* simcall_host_get_name(smx_host_t host)
44 return simcall_BODY_host_get_name(host);
48 * \ingroup simix_host_management
49 * \brief Start the host if it is off
51 * \param host A SIMIX host
53 void simcall_host_on(smx_host_t host)
55 simcall_BODY_host_on(host);
59 * \ingroup simix_host_management
60 * \brief Stop the host if it is on
62 * \param host A SIMIX host
64 void simcall_host_off(smx_host_t host)
66 simcall_BODY_host_off(host);
70 * \ingroup simix_host_management
71 * \brief Returns a dict of the properties assigned to a host.
74 * \return The properties of this host
76 xbt_dict_t simcall_host_get_properties(smx_host_t host)
78 return simcall_BODY_host_get_properties(host);
82 * \ingroup simix_host_management
83 * \brief Returns a dict of the properties assigned to a router or AS.
85 * \param name The name of the router or AS
86 * \return The properties
88 xbt_dict_t simcall_asr_get_properties(const char *name)
90 return simcall_BODY_asr_get_properties(name);
95 * \ingroup simix_host_management
96 * \brief Returns the speed of the processor.
98 * The speed returned does not take into account the current load on the machine.
99 * \param host A SIMIX host
100 * \return The speed of this host (in Mflop/s)
102 double simcall_host_get_speed(smx_host_t host)
104 return simcall_BODY_host_get_speed(host);
108 * \ingroup simix_host_management
109 * \brief Returns the number of core of the processor.
111 * \param host A SIMIX host
112 * \return The number of core
114 int simcall_host_get_core(smx_host_t host)
116 return simcall_BODY_host_get_core(host);
120 * \ingroup simix_host_management
121 * \brief Returns the list of processes attached to the host.
123 * \param host A SIMIX host
124 * \return the swag of attached processes
126 xbt_swag_t simcall_host_get_process_list(smx_host_t host)
128 return simcall_BODY_host_get_process_list(host);
133 * \ingroup simix_host_management
134 * \brief Returns the available speed of the processor.
136 * \return Speed currently available (in Mflop/s)
138 double simcall_host_get_available_speed(smx_host_t host)
140 return simcall_BODY_host_get_available_speed(host);
144 * \ingroup simix_host_management
145 * \brief Returns the state of a host.
147 * Two states are possible: 1 if the host is active or 0 if it has crashed.
148 * \param host A SIMIX host
149 * \return 1 if the host is available, 0 otherwise
151 int simcall_host_get_state(smx_host_t host)
153 return simcall_BODY_host_get_state(host);
157 * \ingroup simix_host_management
158 * \brief Returns the power peak of a host.
160 * \param host A SIMIX host
161 * \return the current power peak value (double)
163 double simcall_host_get_current_power_peak(smx_host_t host)
165 return simcall_BODY_host_get_current_power_peak(host);
169 * \ingroup simix_host_management
170 * \brief Returns one power peak (in flops/s) of a host at a given pstate
172 * \param host A SIMIX host
173 * \param pstate_index pstate to test
174 * \return the current power peak value (double) for pstate_index
176 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
178 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
182 * \ingroup simix_host_management
183 * \brief Returns the number of power states for a host.
185 * \param host A SIMIX host
186 * \return the number of power states
188 int simcall_host_get_nb_pstates(smx_host_t host)
190 return simcall_BODY_host_get_nb_pstates(host);
194 * \ingroup simix_host_management
195 * \brief Sets a new power peak for a host.
197 * \param host A SIMIX host
198 * \param pstate_index The pstate to which the CPU power will be set
200 void simcall_host_set_power_peak_at(smx_host_t host, int pstate_index)
202 simcall_BODY_host_set_power_peak_at(host, pstate_index);
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(smx_host_t host)
214 return simcall_BODY_host_get_consumed_energy(host);
219 * \ingroup simix_host_management
220 * \brief Creates a synchro that executes some computation of an host.
222 * This function creates a SURF action and allocates the data necessary
223 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
225 * \param name Name of the execution synchro to create
226 * \param host SIMIX host where the synchro will be executed
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_host_execute(const char *name, smx_host_t host,
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_host_execute(name, host, flops_amount, priority, bound, affinity_mask);
245 * \ingroup simix_host_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_host_parallel_execute(const char *name,
261 smx_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_host_parallel_execute(name, host_nb, host_list,
288 * \ingroup simix_host_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_host_execution_destroy(smx_synchro_t execution)
296 simcall_BODY_host_execution_destroy(execution);
300 * \ingroup simix_host_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_host_execution_cancel(smx_synchro_t execution)
308 simcall_BODY_host_execution_cancel(execution);
312 * \ingroup simix_host_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_host_execution_get_remains(smx_synchro_t execution)
320 return simcall_BODY_host_execution_get_remains(execution);
324 * \ingroup simix_host_management
325 * \brief Returns the state of an execution synchro.
327 * \param execution The execution synchro
330 e_smx_state_t simcall_host_execution_get_state(smx_synchro_t execution)
332 return simcall_BODY_host_execution_get_state(execution);
336 * \ingroup simix_host_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_host_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_host_execution_set_priority(execution, priority);
352 * \ingroup simix_host_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_host_execution_set_bound(smx_synchro_t execution, double bound)
361 simcall_BODY_host_execution_set_bound(execution, bound);
365 * \ingroup simix_host_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_host_execution_set_affinity(smx_synchro_t execution, smx_host_t host, unsigned long mask)
375 simcall_BODY_host_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_host_execution_wait(smx_synchro_t execution)
386 return simcall_BODY_host_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, smx_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(smx_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(smx_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(smx_host_t vm)
435 return simcall_BODY_vm_get_pm(vm);
438 void simcall_vm_set_bound(smx_host_t vm, double bound)
440 simcall_BODY_vm_set_bound(vm, bound);
443 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
445 simcall_BODY_vm_set_affinity(vm, pm, mask);
448 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
450 simcall_BODY_host_get_params(vm, params);
453 void simcall_host_set_params(smx_host_t vm, ws_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(smx_host_t vm, smx_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(smx_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(smx_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(smx_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(smx_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(smx_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(smx_host_t vm)
533 simcall_BODY_vm_destroy(vm);
538 * \ingroup simix_process_management
539 * \brief Creates and runs a new SIMIX process.
541 * The structure and the corresponding thread are created and put in the list of ready processes.
543 * \param process the process created will be stored in this pointer
544 * \param name a name for the process. It is for user-level information and can be NULL.
545 * \param code the main function of the process
546 * \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.
547 * It can be retrieved with the function \ref simcall_process_get_data.
548 * \param hostname name of the host where the new agent is executed.
549 * \param kill_time time when the process is killed
550 * \param argc first argument passed to \a code
551 * \param argv second argument passed to \a code
552 * \param properties the properties of the process
553 * \param auto_restart either it is autorestarting or not.
555 void simcall_process_create(smx_process_t *process, const char *name,
556 xbt_main_func_t code,
558 const char *hostname,
560 int argc, char **argv,
561 xbt_dict_t properties,
564 simcall_BODY_process_create(process, name, code, data, hostname,
565 kill_time, argc, argv, properties,
570 * \ingroup simix_process_management
571 * \brief Kills a SIMIX process.
573 * This function simply kills a process.
575 * \param process poor victim
577 void simcall_process_kill(smx_process_t process)
579 simcall_BODY_process_kill(process);
583 * \ingroup simix_process_management
584 * \brief Kills all SIMIX processes.
586 void simcall_process_killall(int reset_pid)
588 simcall_BODY_process_killall(reset_pid);
592 * \ingroup simix_process_management
593 * \brief Cleans up a SIMIX process.
594 * \param process poor victim (must have already been killed)
596 void simcall_process_cleanup(smx_process_t process)
598 simcall_BODY_process_cleanup(process);
602 * \ingroup simix_process_management
603 * \brief Migrates an agent to another location.
605 * This function changes the value of the host on which \a process is running.
607 * \param process the process to migrate
608 * \param dest name of the new host
610 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
612 simcall_BODY_process_change_host(process, dest);
615 void simcall_process_join(smx_process_t process, double timeout)
617 simcall_BODY_process_join(process, timeout);
621 * \ingroup simix_process_management
622 * \brief Suspends a process.
624 * This function suspends the process by suspending the synchro
625 * it was waiting for completion.
627 * \param process a SIMIX process
629 void simcall_process_suspend(smx_process_t process)
631 xbt_assert(process, "Invalid parameters");
633 simcall_BODY_process_suspend(process);
637 * \ingroup simix_process_management
638 * \brief Resumes a suspended process.
640 * This function resumes a suspended process by resuming the synchro
641 * it was waiting for completion.
643 * \param process a SIMIX process
645 void simcall_process_resume(smx_process_t process)
647 simcall_BODY_process_resume(process);
651 * \ingroup simix_process_management
652 * \brief Returns the amount of SIMIX processes in the system
654 * Maestro internal process is not counted, only user code processes are
656 int simcall_process_count(void)
658 return simcall_BODY_process_count();
662 * \ingroup simix_process_management
663 * \brief Return the PID of a #smx_process_t.
664 * \param process a SIMIX process
665 * \return the PID of this process
667 int simcall_process_get_PID(smx_process_t process)
669 if (process == SIMIX_process_self()) {
670 /* avoid a simcall if this function is called by the process itself */
671 return SIMIX_process_get_PID(process);
674 return simcall_BODY_process_get_PID(process);
678 * \ingroup simix_process_management
679 * \brief Return the parent PID of a #smx_process_t.
680 * \param process a SIMIX process
681 * \return the PID of this process parenrt
683 int simcall_process_get_PPID(smx_process_t process)
685 if (process == SIMIX_process_self()) {
686 /* avoid a simcall if this function is called by the process itself */
687 return SIMIX_process_get_PPID(process);
690 return simcall_BODY_process_get_PPID(process);
694 * \ingroup simix_process_management
695 * \brief Return the user data of a #smx_process_t.
696 * \param process a SIMIX process
697 * \return the user data of this process
699 void* simcall_process_get_data(smx_process_t process)
701 if (process == SIMIX_process_self()) {
702 /* avoid a simcall if this function is called by the process itself */
703 return SIMIX_process_get_data(process);
706 return simcall_BODY_process_get_data(process);
710 * \ingroup simix_process_management
711 * \brief Set the user data of a #smx_process_t.
713 * This functions sets the user data associated to \a process.
714 * \param process SIMIX process
715 * \param data User data
717 void simcall_process_set_data(smx_process_t process, void *data)
719 if (process == SIMIX_process_self()) {
720 /* avoid a simcall if this function is called by the process itself */
721 SIMIX_process_self_set_data(process, data);
724 simcall_BODY_process_set_data(process, data);
729 * \ingroup simix_process_management
730 * \brief Set the kill time of a process.
731 * \param process a process
732 * \param kill_time a double
734 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
737 if (kill_time > SIMIX_get_clock()) {
738 if (simix_global->kill_process_function) {
739 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
740 sg_host_name(process->smx_host));
741 SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
747 * \ingroup simix_process_management
748 * \brief Return the location on which an agent is running.
750 * This functions returns the smx_host_t corresponding to the location on which
751 * \a process is running.
752 * \param process SIMIX process
755 smx_host_t simcall_process_get_host(smx_process_t process)
757 return simcall_BODY_process_get_host(process);
761 * \ingroup simix_process_management
762 * \brief Return the name of an agent.
764 * This functions checks whether \a process is a valid pointer or not and return its name.
765 * \param process SIMIX process
766 * \return The process name
768 const char* simcall_process_get_name(smx_process_t process)
770 if (process == SIMIX_process_self()) {
771 /* avoid a simcall if this function is called by the process itself */
772 return process->name;
774 return simcall_BODY_process_get_name(process);
778 * \ingroup simix_process_management
779 * \brief Returns true if the process is suspended .
781 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
782 * \param process SIMIX process
783 * \return 1, if the process is suspended, else 0.
785 int simcall_process_is_suspended(smx_process_t process)
787 return simcall_BODY_process_is_suspended(process);
791 * \ingroup simix_process_management
792 * \brief Return the properties
794 * This functions returns the properties associated with this process
796 xbt_dict_t simcall_process_get_properties(smx_process_t process)
798 return simcall_BODY_process_get_properties(process);
801 * \ingroup simix_process_management
802 * \brief Add an on_exit function
803 * Add an on_exit function which will be executed when the process exits/is killed.
805 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
807 simcall_BODY_process_on_exit(process, fun, data);
810 * \ingroup simix_process_management
811 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
812 * Will restart the process when the host comes back up if auto_restart is set to 1.
815 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
817 simcall_BODY_process_auto_restart_set(process, auto_restart);
821 * \ingroup simix_process_management
822 * \brief Restarts the process, killing it and starting it again from scratch.
824 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
826 return simcall_BODY_process_restart(process);
829 * \ingroup simix_process_management
830 * \brief Creates a new sleep SIMIX synchro.
832 * This function creates a SURF action and allocates the data necessary
833 * to create the SIMIX synchro. It can raise a host_error exception if the
834 * host crashed. The default SIMIX name of the synchro is "sleep".
836 * \param duration Time duration of the sleep.
837 * \return A result telling whether the sleep was successful
839 e_smx_state_t simcall_process_sleep(double duration)
841 /* checking for infinite values */
842 xbt_assert(isfinite(duration), "duration is not finite!");
843 return simcall_BODY_process_sleep(duration);
847 * \ingroup simix_rdv_management
848 * \brief Creates a new rendez-vous point
849 * \param name The name of the rendez-vous point
850 * \return The created rendez-vous point
852 smx_rdv_t simcall_rdv_create(const char *name)
854 return simcall_BODY_rdv_create(name);
859 * \ingroup simix_rdv_management
860 * \brief Destroy a rendez-vous point
861 * \param rdv The rendez-vous point to destroy
863 void simcall_rdv_destroy(smx_rdv_t rdv)
865 simcall_BODY_rdv_destroy(rdv);
868 * \ingroup simix_rdv_management
869 * \brief Returns a rendez-vous point knowing its name
871 smx_rdv_t simcall_rdv_get_by_name(const char *name)
873 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
875 /* FIXME: this is a horrible loss of performance, so we hack it out by
876 * skipping the simcall (for now). It works in parallel, it won't work on
877 * distributed but probably we will change MSG for that. */
879 return SIMIX_rdv_get_by_name(name);
883 * \ingroup simix_rdv_management
884 * \brief Counts the number of communication synchros of a given host pending
885 * on a rendez-vous point.
886 * \param rdv The rendez-vous point
887 * \param host The host to be counted
888 * \return The number of comm synchros pending in the rdv
890 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
892 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
896 * \ingroup simix_rdv_management
897 * \brief returns the communication at the head of the rendez-vous
898 * \param rdv The rendez-vous point
899 * \return The communication or NULL if empty
901 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
903 return simcall_BODY_rdv_get_head(rdv);
906 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
908 simcall_BODY_rdv_set_receiver(rdv, process);
911 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
913 return simcall_BODY_rdv_get_receiver(rdv);
917 * \ingroup simix_comm_management
919 void simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
920 void *src_buff, size_t src_buff_size,
921 int (*match_fun)(void *, void *, smx_synchro_t),
922 void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
925 /* checking for infinite values */
926 xbt_assert(isfinite(task_size), "task_size is not finite!");
927 xbt_assert(isfinite(rate), "rate is not finite!");
928 xbt_assert(isfinite(timeout), "timeout is not finite!");
930 xbt_assert(rdv, "No rendez-vous point defined for send");
932 if (MC_is_active() || MC_record_replay_is_active()) {
933 /* the model-checker wants two separate simcalls */
934 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
935 comm = simcall_comm_isend(src, rdv, task_size, rate,
936 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
937 simcall_comm_wait(comm, timeout);
941 simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
942 match_fun, copy_data_fun, data, timeout);
947 * \ingroup simix_comm_management
949 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
950 void *src_buff, size_t src_buff_size,
951 int (*match_fun)(void *, void *, smx_synchro_t),
952 void (*clean_fun)(void *),
953 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
957 /* checking for infinite values */
958 xbt_assert(isfinite(task_size), "task_size is not finite!");
959 xbt_assert(isfinite(rate), "rate is not finite!");
961 xbt_assert(rdv, "No rendez-vous point defined for isend");
963 return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
964 src_buff_size, match_fun,
965 clean_fun, copy_data_fun, data, detached);
969 * \ingroup simix_comm_management
971 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
972 int (*match_fun)(void *, void *, smx_synchro_t),
973 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
974 void *data, double timeout, double rate)
976 xbt_assert(isfinite(timeout), "timeout is not finite!");
977 xbt_assert(rdv, "No rendez-vous point defined for recv");
979 if (MC_is_active() || MC_record_replay_is_active()) {
980 /* the model-checker wants two separate simcalls */
981 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
982 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
983 match_fun, copy_data_fun, data, rate);
984 simcall_comm_wait(comm, timeout);
988 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
989 match_fun, copy_data_fun, data, timeout, rate);
993 * \ingroup simix_comm_management
995 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
996 int (*match_fun)(void *, void *, smx_synchro_t),
997 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
998 void *data, double rate)
1000 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1002 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1003 match_fun, copy_data_fun, data, rate);
1007 * \ingroup simix_comm_management
1009 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1010 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1012 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1014 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1018 * \ingroup simix_comm_management
1020 void simcall_comm_cancel(smx_synchro_t comm)
1022 simcall_BODY_comm_cancel(comm);
1026 * \ingroup simix_comm_management
1028 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1030 return simcall_BODY_comm_waitany(comms);
1034 * \ingroup simix_comm_management
1036 int simcall_comm_testany(xbt_dynar_t comms)
1038 if (xbt_dynar_is_empty(comms))
1040 return simcall_BODY_comm_testany(comms);
1044 * \ingroup simix_comm_management
1046 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1048 xbt_assert(isfinite(timeout), "timeout is not finite!");
1049 simcall_BODY_comm_wait(comm, timeout);
1053 * \brief Set the category of an synchro.
1055 * This functions changes the category only. It calls a surf function.
1056 * \param execution The execution synchro
1057 * \param category The tracing category
1059 void simcall_set_category(smx_synchro_t synchro, const char *category)
1061 if (category == NULL) {
1064 simcall_BODY_set_category(synchro, category);
1068 * \ingroup simix_comm_management
1071 int simcall_comm_test(smx_synchro_t comm)
1073 return simcall_BODY_comm_test(comm);
1077 * \ingroup simix_comm_management
1080 double simcall_comm_get_remains(smx_synchro_t comm)
1082 return simcall_BODY_comm_get_remains(comm);
1086 * \ingroup simix_comm_management
1089 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1091 return simcall_BODY_comm_get_state(comm);
1095 * \ingroup simix_comm_management
1098 void *simcall_comm_get_src_data(smx_synchro_t comm)
1100 return simcall_BODY_comm_get_src_data(comm);
1104 * \ingroup simix_comm_management
1107 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1109 return simcall_BODY_comm_get_dst_data(comm);
1113 * \ingroup simix_comm_management
1116 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1118 return simcall_BODY_comm_get_src_proc(comm);
1122 * \ingroup simix_comm_management
1125 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1127 return simcall_BODY_comm_get_dst_proc(comm);
1130 #ifdef HAVE_LATENCY_BOUND_TRACKING
1131 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1133 return simcall_BODY_comm_is_latency_bounded(comm);
1138 * \ingroup simix_synchro_management
1141 smx_mutex_t simcall_mutex_init(void)
1144 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
1147 return simcall_BODY_mutex_init();
1151 * \ingroup simix_synchro_management
1154 void simcall_mutex_destroy(smx_mutex_t mutex)
1156 simcall_BODY_mutex_destroy(mutex);
1160 * \ingroup simix_synchro_management
1163 void simcall_mutex_lock(smx_mutex_t mutex)
1165 simcall_BODY_mutex_lock(mutex);
1169 * \ingroup simix_synchro_management
1172 int simcall_mutex_trylock(smx_mutex_t mutex)
1174 return simcall_BODY_mutex_trylock(mutex);
1178 * \ingroup simix_synchro_management
1181 void simcall_mutex_unlock(smx_mutex_t mutex)
1183 simcall_BODY_mutex_unlock(mutex);
1187 * \ingroup simix_synchro_management
1190 smx_cond_t simcall_cond_init(void)
1192 return simcall_BODY_cond_init();
1196 * \ingroup simix_synchro_management
1199 void simcall_cond_destroy(smx_cond_t cond)
1201 simcall_BODY_cond_destroy(cond);
1205 * \ingroup simix_synchro_management
1208 void simcall_cond_signal(smx_cond_t cond)
1210 simcall_BODY_cond_signal(cond);
1214 * \ingroup simix_synchro_management
1217 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1219 simcall_BODY_cond_wait(cond, mutex);
1223 * \ingroup simix_synchro_management
1226 void simcall_cond_wait_timeout(smx_cond_t cond,
1230 xbt_assert(isfinite(timeout), "timeout is not finite!");
1231 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1235 * \ingroup simix_synchro_management
1238 void simcall_cond_broadcast(smx_cond_t cond)
1240 simcall_BODY_cond_broadcast(cond);
1244 * \ingroup simix_synchro_management
1247 smx_sem_t simcall_sem_init(int capacity)
1249 return simcall_BODY_sem_init(capacity);
1253 * \ingroup simix_synchro_management
1256 void simcall_sem_destroy(smx_sem_t sem)
1258 simcall_BODY_sem_destroy(sem);
1262 * \ingroup simix_synchro_management
1265 void simcall_sem_release(smx_sem_t sem)
1267 simcall_BODY_sem_release(sem);
1271 * \ingroup simix_synchro_management
1274 int simcall_sem_would_block(smx_sem_t sem)
1276 return simcall_BODY_sem_would_block(sem);
1280 * \ingroup simix_synchro_management
1283 void simcall_sem_acquire(smx_sem_t sem)
1285 simcall_BODY_sem_acquire(sem);
1289 * \ingroup simix_synchro_management
1292 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1294 xbt_assert(isfinite(timeout), "timeout is not finite!");
1295 simcall_BODY_sem_acquire_timeout(sem, timeout);
1299 * \ingroup simix_synchro_management
1302 int simcall_sem_get_capacity(smx_sem_t sem)
1304 return simcall_BODY_sem_get_capacity(sem);
1308 * \ingroup simix_file_management
1311 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, smx_host_t host)
1313 return simcall_BODY_file_read(fd, size, host);
1317 * \ingroup simix_file_management
1320 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, smx_host_t host)
1322 return simcall_BODY_file_write(fd, size, host);
1326 * \ingroup simix_file_management
1329 smx_file_t simcall_file_open(const char* fullpath, smx_host_t host)
1331 return simcall_BODY_file_open(fullpath, host);
1335 * \ingroup simix_file_management
1338 int simcall_file_close(smx_file_t fd, smx_host_t host)
1340 return simcall_BODY_file_close(fd, host);
1344 * \ingroup simix_file_management
1347 int simcall_file_unlink(smx_file_t fd, smx_host_t host)
1349 return simcall_BODY_file_unlink(fd, host);
1353 * \ingroup simix_file_management
1356 sg_size_t simcall_file_get_size(smx_file_t fd){
1357 return simcall_BODY_file_get_size(fd);
1361 * \ingroup simix_file_management
1364 sg_size_t simcall_file_tell(smx_file_t fd){
1365 return simcall_BODY_file_tell(fd);
1369 * \ingroup simix_file_management
1372 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1374 return simcall_BODY_file_get_info(fd);
1378 * \ingroup simix_file_management
1381 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1382 return simcall_BODY_file_seek(fd, offset, origin);
1386 * \ingroup simix_file_management
1387 * \brief Move a file to another location on the *same mount point*.
1390 int simcall_file_move(smx_file_t fd, const char* fullpath)
1392 return simcall_BODY_file_move(fd, fullpath);
1396 * \ingroup simix_storage_management
1397 * \brief Returns the free space size on a given storage element.
1398 * \param storage a storage
1399 * \return Return the free space size on a given storage element (as sg_size_t)
1401 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1402 return simcall_BODY_storage_get_free_size(storage);
1406 * \ingroup simix_storage_management
1407 * \brief Returns the used space size on a given storage element.
1408 * \param storage a storage
1409 * \return Return the used space size on a given storage element (as sg_size_t)
1411 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1412 return simcall_BODY_storage_get_used_size(storage);
1416 * \ingroup simix_storage_management
1417 * \brief Returns the list of storages mounted on an host.
1418 * \param host A SIMIX host
1419 * \return a dict containing all storages mounted on the host
1421 xbt_dict_t simcall_host_get_mounted_storage_list(smx_host_t host)
1423 return simcall_BODY_host_get_mounted_storage_list(host);
1427 * \ingroup simix_storage_management
1428 * \brief Returns the list of storages attached to an host.
1429 * \param host A SIMIX host
1430 * \return a dict containing all storages attached to the host
1432 xbt_dynar_t simcall_host_get_attached_storage_list(smx_host_t host)
1434 return simcall_BODY_host_get_attached_storage_list(host);
1438 * \ingroup simix_storage_management
1439 * \brief Returns a dict of the properties assigned to a storage element.
1441 * \param storage A storage element
1442 * \return The properties of this storage element
1444 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1446 return simcall_BODY_storage_get_properties(storage);
1450 * \ingroup simix_storage_management
1451 * \brief Returns a dict containing the content of a storage element.
1453 * \param storage A storage element
1454 * \return The content of this storage element as a dict (full path file => size)
1456 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1458 return simcall_BODY_storage_get_content(storage);
1465 void *simcall_mc_snapshot(void) {
1466 return simcall_BODY_mc_snapshot();
1469 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1470 return simcall_BODY_mc_compare_snapshots(s1, s2);
1473 #endif /* HAVE_MC */
1475 int simcall_mc_random(int min, int max) {
1476 return simcall_BODY_mc_random(min, max);
1479 /* ************************************************************************** */
1481 /** @brief returns a printable string representing a simcall */
1482 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1483 return simcall_names[kind];