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 the name of a host.
28 * \param host A SIMIX host
29 * \return The name of this host
31 const char* simcall_host_get_name(sg_host_t host)
33 return simcall_BODY_host_get_name(host);
37 * \ingroup simix_host_management
38 * \brief Start the host if it is off
40 * \param host A SIMIX host
42 void simcall_host_on(sg_host_t host)
44 simcall_BODY_host_on(host);
48 * \ingroup simix_host_management
49 * \brief Stop the host if it is on
51 * \param host A SIMIX host
53 void simcall_host_off(sg_host_t host)
55 simcall_BODY_host_off(host);
59 * \ingroup simix_host_management
60 * \brief Returns a dict of the properties assigned to a host.
63 * \return The properties of this host
65 xbt_dict_t simcall_host_get_properties(sg_host_t host)
67 return simcall_BODY_host_get_properties(host);
71 * \ingroup simix_host_management
72 * \brief Returns a dict of the properties assigned to a router or AS.
74 * \param name The name of the router or AS
75 * \return The properties
77 xbt_dict_t simcall_asr_get_properties(const char *name)
79 return simcall_BODY_asr_get_properties(name);
84 * \ingroup simix_host_management
85 * \brief Returns the speed of the processor.
87 * The speed returned does not take into account the current load on the machine.
88 * \param host A SIMIX host
89 * \return The speed of this host (in Mflop/s)
91 double simcall_host_get_speed(sg_host_t host)
93 return simcall_BODY_host_get_speed(host);
97 * \ingroup simix_host_management
98 * \brief Returns the number of core of the processor.
100 * \param host A SIMIX host
101 * \return The number of core
103 int simcall_host_get_core(sg_host_t host)
105 return simcall_BODY_host_get_core(host);
109 * \ingroup simix_host_management
110 * \brief Returns the list of processes attached to the host.
112 * \param host A SIMIX host
113 * \return the swag of attached processes
115 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
117 return simcall_BODY_host_get_process_list(host);
122 * \ingroup simix_host_management
123 * \brief Returns the available speed of the processor.
125 * \return Speed currently available (in Mflop/s)
127 double simcall_host_get_available_speed(sg_host_t host)
129 return simcall_BODY_host_get_available_speed(host);
133 * \ingroup simix_host_management
134 * \brief Returns the state of a host.
136 * Two states are possible: 1 if the host is active or 0 if it has crashed.
137 * \param host A SIMIX host
138 * \return 1 if the host is available, 0 otherwise
140 int simcall_host_get_state(sg_host_t host)
142 return simcall_BODY_host_get_state(host);
146 * \ingroup simix_host_management
147 * \brief Returns the power peak of a host.
149 * \param host A SIMIX host
150 * \return the current power peak value (double)
152 double simcall_host_get_current_power_peak(sg_host_t host)
154 return simcall_BODY_host_get_current_power_peak(host);
158 * \ingroup simix_host_management
159 * \brief Returns one power peak (in flops/s) of a host at a given pstate
161 * \param host A SIMIX host
162 * \param pstate_index pstate to test
163 * \return the current power peak value (double) for pstate_index
165 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
167 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
171 * \ingroup simix_host_management
172 * \brief Returns the number of power states for a host.
174 * \param host A SIMIX host
175 * \return the number of power states
177 int simcall_host_get_nb_pstates(sg_host_t host)
179 return simcall_BODY_host_get_nb_pstates(host);
183 * \ingroup simix_host_management
184 * \brief Sets the pstate at which the host should run
186 * \param host A SIMIX host
187 * \param pstate_index The pstate to which the CPU power will be set
189 void simcall_host_set_pstate(sg_host_t host, int pstate_index)
191 simcall_BODY_host_set_pstate(host, pstate_index);
194 * \ingroup simix_host_management
195 * \brief Gets the pstate at which that host currently runs.
197 * \param host A SIMIX host
199 int simcall_host_get_pstate(sg_host_t host)
201 return simcall_BODY_host_get_pstate(host);
205 * \ingroup simix_host_management
206 * \brief Returns the total energy consumed by the host (in Joules)
208 * \param host A SIMIX host
209 * \return the energy consumed by the host (double)
211 double simcall_host_get_consumed_energy(sg_host_t host)
213 return simcall_BODY_host_get_consumed_energy(host);
215 /** \ingroup simix_host_management
216 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
218 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
219 return simcall_BODY_host_get_wattmin_at(host, pstate);
221 /** \ingroup simix_host_management
222 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
224 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
225 return simcall_BODY_host_get_wattmax_at(host, pstate);
231 * \ingroup simix_host_management
232 * \brief Creates a synchro that executes some computation of an host.
234 * This function creates a SURF action and allocates the data necessary
235 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
237 * \param name Name of the execution synchro to create
238 * \param host SIMIX host where the synchro will be executed
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_host_execute(const char *name, sg_host_t host,
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_host_execute(name, host, flops_amount, priority, bound, affinity_mask);
257 * \ingroup simix_host_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_host_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_host_parallel_execute(name, host_nb, host_list,
300 * \ingroup simix_host_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_host_execution_destroy(smx_synchro_t execution)
308 simcall_BODY_host_execution_destroy(execution);
312 * \ingroup simix_host_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_host_execution_cancel(smx_synchro_t execution)
320 simcall_BODY_host_execution_cancel(execution);
324 * \ingroup simix_host_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_host_execution_get_remains(smx_synchro_t execution)
332 return simcall_BODY_host_execution_get_remains(execution);
336 * \ingroup simix_host_management
337 * \brief Returns the state of an execution synchro.
339 * \param execution The execution synchro
342 e_smx_state_t simcall_host_execution_get_state(smx_synchro_t execution)
344 return simcall_BODY_host_execution_get_state(execution);
348 * \ingroup simix_host_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_host_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_host_execution_set_priority(execution, priority);
364 * \ingroup simix_host_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_host_execution_set_bound(smx_synchro_t execution, double bound)
373 simcall_BODY_host_execution_set_bound(execution, bound);
377 * \ingroup simix_host_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_host_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
387 simcall_BODY_host_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_host_execution_wait(smx_synchro_t execution)
398 return simcall_BODY_host_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 process the process created will be stored in this pointer
574 * \param name a name for the process. It is for user-level information and can be NULL.
575 * \param code the main function of the process
576 * \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.
577 * It can be retrieved with the function \ref simcall_process_get_data.
578 * \param hostname name of the host where the new agent is executed.
579 * \param kill_time time when the process is killed
580 * \param argc first argument passed to \a code
581 * \param argv second argument passed to \a code
582 * \param properties the properties of the process
583 * \param auto_restart either it is autorestarting or not.
585 void simcall_process_create(smx_process_t *process, const char *name,
586 xbt_main_func_t code,
588 const char *hostname,
590 int argc, char **argv,
591 xbt_dict_t properties,
594 simcall_BODY_process_create(process, name, code, data, hostname,
595 kill_time, argc, argv, properties,
600 * \ingroup simix_process_management
601 * \brief Kills a SIMIX process.
603 * This function simply kills a process.
605 * \param process poor victim
607 void simcall_process_kill(smx_process_t process)
609 simcall_BODY_process_kill(process);
613 * \ingroup simix_process_management
614 * \brief Kills all SIMIX processes.
616 void simcall_process_killall(int reset_pid)
618 simcall_BODY_process_killall(reset_pid);
622 * \ingroup simix_process_management
623 * \brief Cleans up a SIMIX process.
624 * \param process poor victim (must have already been killed)
626 void simcall_process_cleanup(smx_process_t process)
628 simcall_BODY_process_cleanup(process);
632 * \ingroup simix_process_management
633 * \brief Migrates an agent to another location.
635 * This function changes the value of the host on which \a process is running.
637 * \param process the process to migrate
638 * \param dest name of the new host
640 void simcall_process_change_host(smx_process_t process, sg_host_t dest)
642 simcall_BODY_process_change_host(process, dest);
645 void simcall_process_join(smx_process_t process, double timeout)
647 simcall_BODY_process_join(process, timeout);
651 * \ingroup simix_process_management
652 * \brief Suspends a process.
654 * This function suspends the process by suspending the synchro
655 * it was waiting for completion.
657 * \param process a SIMIX process
659 void simcall_process_suspend(smx_process_t process)
661 xbt_assert(process, "Invalid parameters");
663 simcall_BODY_process_suspend(process);
667 * \ingroup simix_process_management
668 * \brief Resumes a suspended process.
670 * This function resumes a suspended process by resuming the synchro
671 * it was waiting for completion.
673 * \param process a SIMIX process
675 void simcall_process_resume(smx_process_t process)
677 simcall_BODY_process_resume(process);
681 * \ingroup simix_process_management
682 * \brief Returns the amount of SIMIX processes in the system
684 * Maestro internal process is not counted, only user code processes are
686 int simcall_process_count(void)
688 return simcall_BODY_process_count();
692 * \ingroup simix_process_management
693 * \brief Return the PID of a #smx_process_t.
694 * \param process a SIMIX process
695 * \return the PID of this process
697 int simcall_process_get_PID(smx_process_t process)
699 if (process == SIMIX_process_self()) {
700 /* avoid a simcall if this function is called by the process itself */
701 return SIMIX_process_get_PID(process);
704 return simcall_BODY_process_get_PID(process);
708 * \ingroup simix_process_management
709 * \brief Return the parent PID of a #smx_process_t.
710 * \param process a SIMIX process
711 * \return the PID of this process parenrt
713 int simcall_process_get_PPID(smx_process_t process)
715 if (process == SIMIX_process_self()) {
716 /* avoid a simcall if this function is called by the process itself */
717 return SIMIX_process_get_PPID(process);
720 return simcall_BODY_process_get_PPID(process);
724 * \ingroup simix_process_management
725 * \brief Return the user data of a #smx_process_t.
726 * \param process a SIMIX process
727 * \return the user data of this process
729 void* simcall_process_get_data(smx_process_t process)
731 if (process == SIMIX_process_self()) {
732 /* avoid a simcall if this function is called by the process itself */
733 return SIMIX_process_get_data(process);
736 return simcall_BODY_process_get_data(process);
740 * \ingroup simix_process_management
741 * \brief Set the user data of a #smx_process_t.
743 * This functions sets the user data associated to \a process.
744 * \param process SIMIX process
745 * \param data User data
747 void simcall_process_set_data(smx_process_t process, void *data)
749 if (process == SIMIX_process_self()) {
750 /* avoid a simcall if this function is called by the process itself */
751 SIMIX_process_self_set_data(process, data);
754 simcall_BODY_process_set_data(process, data);
759 * \ingroup simix_process_management
760 * \brief Set the kill time of a process.
761 * \param process a process
762 * \param kill_time a double
764 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
767 if (kill_time > SIMIX_get_clock()) {
768 if (simix_global->kill_process_function) {
769 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
770 sg_host_name(process->host));
771 process->kill_timer = SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
777 * \ingroup simix_process_management
778 * \brief Return the location on which an agent is running.
780 * This functions returns the sg_host_t corresponding to the location on which
781 * \a process is running.
782 * \param process SIMIX process
785 sg_host_t simcall_process_get_host(smx_process_t process)
787 return simcall_BODY_process_get_host(process);
791 * \ingroup simix_process_management
792 * \brief Return the name of an agent.
794 * This functions checks whether \a process is a valid pointer or not and return its name.
795 * \param process SIMIX process
796 * \return The process name
798 const char* simcall_process_get_name(smx_process_t process)
800 if (process == SIMIX_process_self()) {
801 /* avoid a simcall if this function is called by the process itself */
802 return process->name;
804 return simcall_BODY_process_get_name(process);
808 * \ingroup simix_process_management
809 * \brief Returns true if the process is suspended .
811 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
812 * \param process SIMIX process
813 * \return 1, if the process is suspended, else 0.
815 int simcall_process_is_suspended(smx_process_t process)
817 return simcall_BODY_process_is_suspended(process);
821 * \ingroup simix_process_management
822 * \brief Return the properties
824 * This functions returns the properties associated with this process
826 xbt_dict_t simcall_process_get_properties(smx_process_t process)
828 return simcall_BODY_process_get_properties(process);
831 * \ingroup simix_process_management
832 * \brief Add an on_exit function
833 * Add an on_exit function which will be executed when the process exits/is killed.
835 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
837 simcall_BODY_process_on_exit(process, fun, data);
840 * \ingroup simix_process_management
841 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
842 * Will restart the process when the host comes back up if auto_restart is set to 1.
845 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
847 simcall_BODY_process_auto_restart_set(process, auto_restart);
851 * \ingroup simix_process_management
852 * \brief Restarts the process, killing it and starting it again from scratch.
854 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
856 return simcall_BODY_process_restart(process);
859 * \ingroup simix_process_management
860 * \brief Creates a new sleep SIMIX synchro.
862 * This function creates a SURF action and allocates the data necessary
863 * to create the SIMIX synchro. It can raise a host_error exception if the
864 * host crashed. The default SIMIX name of the synchro is "sleep".
866 * \param duration Time duration of the sleep.
867 * \return A result telling whether the sleep was successful
869 e_smx_state_t simcall_process_sleep(double duration)
871 /* checking for infinite values */
872 xbt_assert(isfinite(duration), "duration is not finite!");
873 return simcall_BODY_process_sleep(duration);
877 * \ingroup simix_rdv_management
878 * \brief Creates a new rendez-vous point
879 * \param name The name of the rendez-vous point
880 * \return The created rendez-vous point
882 smx_rdv_t simcall_rdv_create(const char *name)
884 return simcall_BODY_rdv_create(name);
889 * \ingroup simix_rdv_management
890 * \brief Destroy a rendez-vous point
891 * \param rdv The rendez-vous point to destroy
893 void simcall_rdv_destroy(smx_rdv_t rdv)
895 simcall_BODY_rdv_destroy(rdv);
898 * \ingroup simix_rdv_management
899 * \brief Returns a rendez-vous point knowing its name
901 smx_rdv_t simcall_rdv_get_by_name(const char *name)
903 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
905 /* FIXME: this is a horrible loss of performance, so we hack it out by
906 * skipping the simcall (for now). It works in parallel, it won't work on
907 * distributed but probably we will change MSG for that. */
909 return SIMIX_rdv_get_by_name(name);
913 * \ingroup simix_rdv_management
914 * \brief Counts the number of communication synchros of a given host pending
915 * on a rendez-vous point.
916 * \param rdv The rendez-vous point
917 * \param host The host to be counted
918 * \return The number of comm synchros pending in the rdv
920 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
922 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
926 * \ingroup simix_rdv_management
927 * \brief returns the communication at the head of the rendez-vous
928 * \param rdv The rendez-vous point
929 * \return The communication or NULL if empty
931 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
933 return simcall_BODY_rdv_get_head(rdv);
936 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
938 simcall_BODY_rdv_set_receiver(rdv, process);
941 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
943 return simcall_BODY_rdv_get_receiver(rdv);
947 * \ingroup simix_comm_management
949 void simcall_comm_send(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 (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
955 /* checking for infinite values */
956 xbt_assert(isfinite(task_size), "task_size is not finite!");
957 xbt_assert(isfinite(rate), "rate is not finite!");
958 xbt_assert(isfinite(timeout), "timeout is not finite!");
960 xbt_assert(rdv, "No rendez-vous point defined for send");
962 if (MC_is_active() || MC_record_replay_is_active()) {
963 /* the model-checker wants two separate simcalls */
964 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
965 comm = simcall_comm_isend(src, rdv, task_size, rate,
966 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
967 simcall_comm_wait(comm, timeout);
971 simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
972 match_fun, copy_data_fun, data, timeout);
977 * \ingroup simix_comm_management
979 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
980 void *src_buff, size_t src_buff_size,
981 int (*match_fun)(void *, void *, smx_synchro_t),
982 void (*clean_fun)(void *),
983 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
987 /* checking for infinite values */
988 xbt_assert(isfinite(task_size), "task_size is not finite!");
989 xbt_assert(isfinite(rate), "rate is not finite!");
991 xbt_assert(rdv, "No rendez-vous point defined for isend");
993 return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
994 src_buff_size, match_fun,
995 clean_fun, copy_data_fun, data, detached);
999 * \ingroup simix_comm_management
1001 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
1002 int (*match_fun)(void *, void *, smx_synchro_t),
1003 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1004 void *data, double timeout, double rate)
1006 xbt_assert(isfinite(timeout), "timeout is not finite!");
1007 xbt_assert(rdv, "No rendez-vous point defined for recv");
1009 if (MC_is_active() || MC_record_replay_is_active()) {
1010 /* the model-checker wants two separate simcalls */
1011 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
1012 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
1013 match_fun, copy_data_fun, data, rate);
1014 simcall_comm_wait(comm, timeout);
1018 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
1019 match_fun, copy_data_fun, data, timeout, rate);
1023 * \ingroup simix_comm_management
1025 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1026 int (*match_fun)(void *, void *, smx_synchro_t),
1027 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
1028 void *data, double rate)
1030 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1032 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1033 match_fun, copy_data_fun, data, rate);
1037 * \ingroup simix_comm_management
1039 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1040 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1042 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1044 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1048 * \ingroup simix_comm_management
1050 void simcall_comm_cancel(smx_synchro_t comm)
1052 simcall_BODY_comm_cancel(comm);
1056 * \ingroup simix_comm_management
1058 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1060 return simcall_BODY_comm_waitany(comms);
1064 * \ingroup simix_comm_management
1066 int simcall_comm_testany(xbt_dynar_t comms)
1068 if (xbt_dynar_is_empty(comms))
1070 return simcall_BODY_comm_testany(comms);
1074 * \ingroup simix_comm_management
1076 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1078 xbt_assert(isfinite(timeout), "timeout is not finite!");
1079 simcall_BODY_comm_wait(comm, timeout);
1083 * \brief Set the category of an synchro.
1085 * This functions changes the category only. It calls a surf function.
1086 * \param execution The execution synchro
1087 * \param category The tracing category
1089 void simcall_set_category(smx_synchro_t synchro, const char *category)
1091 if (category == NULL) {
1094 simcall_BODY_set_category(synchro, category);
1098 * \ingroup simix_comm_management
1101 int simcall_comm_test(smx_synchro_t comm)
1103 return simcall_BODY_comm_test(comm);
1107 * \ingroup simix_comm_management
1110 double simcall_comm_get_remains(smx_synchro_t comm)
1112 return simcall_BODY_comm_get_remains(comm);
1116 * \ingroup simix_comm_management
1119 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1121 return simcall_BODY_comm_get_state(comm);
1125 * \ingroup simix_comm_management
1128 void *simcall_comm_get_src_data(smx_synchro_t comm)
1130 return simcall_BODY_comm_get_src_data(comm);
1134 * \ingroup simix_comm_management
1137 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1139 return simcall_BODY_comm_get_dst_data(comm);
1143 * \ingroup simix_comm_management
1146 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1148 return simcall_BODY_comm_get_src_proc(comm);
1152 * \ingroup simix_comm_management
1155 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1157 return simcall_BODY_comm_get_dst_proc(comm);
1160 #ifdef HAVE_LATENCY_BOUND_TRACKING
1161 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1163 return simcall_BODY_comm_is_latency_bounded(comm);
1168 * \ingroup simix_synchro_management
1171 smx_mutex_t simcall_mutex_init(void)
1174 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
1177 return simcall_BODY_mutex_init();
1181 * \ingroup simix_synchro_management
1184 void simcall_mutex_destroy(smx_mutex_t mutex)
1186 simcall_BODY_mutex_destroy(mutex);
1190 * \ingroup simix_synchro_management
1193 void simcall_mutex_lock(smx_mutex_t mutex)
1195 simcall_BODY_mutex_lock(mutex);
1199 * \ingroup simix_synchro_management
1202 int simcall_mutex_trylock(smx_mutex_t mutex)
1204 return simcall_BODY_mutex_trylock(mutex);
1208 * \ingroup simix_synchro_management
1211 void simcall_mutex_unlock(smx_mutex_t mutex)
1213 simcall_BODY_mutex_unlock(mutex);
1217 * \ingroup simix_synchro_management
1220 smx_cond_t simcall_cond_init(void)
1222 return simcall_BODY_cond_init();
1226 * \ingroup simix_synchro_management
1229 void simcall_cond_destroy(smx_cond_t cond)
1231 simcall_BODY_cond_destroy(cond);
1235 * \ingroup simix_synchro_management
1238 void simcall_cond_signal(smx_cond_t cond)
1240 simcall_BODY_cond_signal(cond);
1244 * \ingroup simix_synchro_management
1247 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1249 simcall_BODY_cond_wait(cond, mutex);
1253 * \ingroup simix_synchro_management
1256 void simcall_cond_wait_timeout(smx_cond_t cond,
1260 xbt_assert(isfinite(timeout), "timeout is not finite!");
1261 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1265 * \ingroup simix_synchro_management
1268 void simcall_cond_broadcast(smx_cond_t cond)
1270 simcall_BODY_cond_broadcast(cond);
1274 * \ingroup simix_synchro_management
1277 smx_sem_t simcall_sem_init(int capacity)
1279 return simcall_BODY_sem_init(capacity);
1283 * \ingroup simix_synchro_management
1286 void simcall_sem_destroy(smx_sem_t sem)
1288 simcall_BODY_sem_destroy(sem);
1292 * \ingroup simix_synchro_management
1295 void simcall_sem_release(smx_sem_t sem)
1297 simcall_BODY_sem_release(sem);
1301 * \ingroup simix_synchro_management
1304 int simcall_sem_would_block(smx_sem_t sem)
1306 return simcall_BODY_sem_would_block(sem);
1310 * \ingroup simix_synchro_management
1313 void simcall_sem_acquire(smx_sem_t sem)
1315 simcall_BODY_sem_acquire(sem);
1319 * \ingroup simix_synchro_management
1322 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1324 xbt_assert(isfinite(timeout), "timeout is not finite!");
1325 simcall_BODY_sem_acquire_timeout(sem, timeout);
1329 * \ingroup simix_synchro_management
1332 int simcall_sem_get_capacity(smx_sem_t sem)
1334 return simcall_BODY_sem_get_capacity(sem);
1338 * \ingroup simix_file_management
1341 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1343 return simcall_BODY_file_read(fd, size, host);
1347 * \ingroup simix_file_management
1350 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1352 return simcall_BODY_file_write(fd, size, host);
1356 * \ingroup simix_file_management
1359 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1361 return simcall_BODY_file_open(fullpath, host);
1365 * \ingroup simix_file_management
1368 int simcall_file_close(smx_file_t fd, sg_host_t host)
1370 return simcall_BODY_file_close(fd, host);
1374 * \ingroup simix_file_management
1377 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1379 return simcall_BODY_file_unlink(fd, host);
1383 * \ingroup simix_file_management
1386 sg_size_t simcall_file_get_size(smx_file_t fd){
1387 return simcall_BODY_file_get_size(fd);
1391 * \ingroup simix_file_management
1394 sg_size_t simcall_file_tell(smx_file_t fd){
1395 return simcall_BODY_file_tell(fd);
1399 * \ingroup simix_file_management
1402 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1404 return simcall_BODY_file_get_info(fd);
1408 * \ingroup simix_file_management
1411 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1412 return simcall_BODY_file_seek(fd, offset, origin);
1416 * \ingroup simix_file_management
1417 * \brief Move a file to another location on the *same mount point*.
1420 int simcall_file_move(smx_file_t fd, const char* fullpath)
1422 return simcall_BODY_file_move(fd, fullpath);
1426 * \ingroup simix_storage_management
1427 * \brief Returns the free space size on a given storage element.
1428 * \param storage a storage
1429 * \return Return the free space size on a given storage element (as sg_size_t)
1431 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1432 return simcall_BODY_storage_get_free_size(storage);
1436 * \ingroup simix_storage_management
1437 * \brief Returns the used space size on a given storage element.
1438 * \param storage a storage
1439 * \return Return the used space size on a given storage element (as sg_size_t)
1441 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1442 return simcall_BODY_storage_get_used_size(storage);
1446 * \ingroup simix_storage_management
1447 * \brief Returns the list of storages mounted on an host.
1448 * \param host A SIMIX host
1449 * \return a dict containing all storages mounted on the host
1451 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
1453 return simcall_BODY_host_get_mounted_storage_list(host);
1457 * \ingroup simix_storage_management
1458 * \brief Returns the list of storages attached to an host.
1459 * \param host A SIMIX host
1460 * \return a dict containing all storages attached to the host
1462 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
1464 return simcall_BODY_host_get_attached_storage_list(host);
1468 * \ingroup simix_storage_management
1469 * \brief Returns a dict of the properties assigned to a storage element.
1471 * \param storage A storage element
1472 * \return The properties of this storage element
1474 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1476 return simcall_BODY_storage_get_properties(storage);
1480 * \ingroup simix_storage_management
1481 * \brief Returns a dict containing the content of a storage element.
1483 * \param storage A storage element
1484 * \return The content of this storage element as a dict (full path file => size)
1486 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1488 return simcall_BODY_storage_get_content(storage);
1495 void *simcall_mc_snapshot(void) {
1496 return simcall_BODY_mc_snapshot();
1499 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1500 return simcall_BODY_mc_compare_snapshots(s1, s2);
1503 #endif /* HAVE_MC */
1505 int simcall_mc_random(int min, int max) {
1506 return simcall_BODY_mc_random(min, max);
1509 /* ************************************************************************** */
1511 /** @brief returns a printable string representing a simcall */
1512 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1513 return simcall_names[kind];