1 /* libsmx.c - public interface to simix */
3 /* These functions are the only ones that are visible from the higher levels */
4 /* (most of them simply add some documentation to the generated simcall body) */
6 /* This is somehow the "libc" of SimGrid */
8 /* Copyright (c) 2010-2015. The SimGrid Team.
9 * All rights reserved. */
11 /* This program is free software; you can redistribute it and/or modify it
12 * under the terms of the license (GNU LGPL) which comes with this package. */
14 #include "src/mc/mc_replay.h"
15 #include "smx_private.h"
16 #include "src/mc/mc_forward.h"
18 #include <math.h> /* isfinite() */
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
23 #include "popping_bodies.c"
26 * \ingroup simix_host_management
27 * \brief Start the host if it is off
29 * \param host A SIMIX host
31 void simcall_host_on(sg_host_t host)
33 simcall_BODY_host_on(host);
37 * \ingroup simix_host_management
38 * \brief Stop the host if it is on
40 * \param host A SIMIX host
42 void simcall_host_off(sg_host_t host)
44 simcall_BODY_host_off(host);
48 * \ingroup simix_host_management
49 * \brief Returns a dict of the properties assigned to a host.
52 * \return The properties of this host
54 xbt_dict_t simcall_host_get_properties(sg_host_t host)
56 return simcall_BODY_host_get_properties(host);
60 * \ingroup simix_host_management
61 * \brief Returns a dict of the properties assigned to a router or AS.
63 * \param name The name of the router or AS
64 * \return The properties
66 xbt_dict_t simcall_asr_get_properties(const char *name)
68 return simcall_BODY_asr_get_properties(name);
72 * \ingroup simix_host_management
73 * \brief Returns the list of processes attached to the host.
75 * \param host A SIMIX host
76 * \return the swag of attached processes
78 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
80 return simcall_BODY_host_get_process_list(host);
84 * \ingroup simix_host_management
85 * \brief Returns the power peak of a host.
87 * \param host A SIMIX host
88 * \return the current power peak value (double)
90 double simcall_host_get_current_power_peak(sg_host_t host)
92 return simcall_BODY_host_get_current_power_peak(host);
96 * \ingroup simix_host_management
97 * \brief Returns one power peak (in flops/s) of a host at a given pstate
99 * \param host A SIMIX host
100 * \param pstate_index pstate to test
101 * \return the current power peak value (double) for pstate_index
103 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
105 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
109 * \ingroup simix_host_management
110 * \brief Sets the pstate at which the host should run
112 * \param host A SIMIX host
113 * \param pstate_index The pstate to which the CPU power will be set
115 void simcall_host_set_pstate(sg_host_t host, int pstate_index)
117 simcall_BODY_host_set_pstate(host, pstate_index);
120 /** \ingroup simix_host_management
121 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
123 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
124 return simcall_BODY_host_get_wattmin_at(host, pstate);
126 /** \ingroup simix_host_management
127 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
129 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
130 return simcall_BODY_host_get_wattmax_at(host, pstate);
136 * \ingroup simix_process_management
137 * \brief Creates a synchro that executes some computation of an host.
139 * This function creates a SURF action and allocates the data necessary
140 * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
142 * \param name Name of the execution synchro to create
143 * \param flops_amount amount Computation amount (in flops)
144 * \param priority computation priority
146 * \param affinity_mask
147 * \return A new SIMIX execution synchronization
149 smx_synchro_t simcall_process_execute(const char *name,
151 double priority, double bound, unsigned long affinity_mask)
153 /* checking for infinite values */
154 xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
155 xbt_assert(isfinite(priority), "priority is not finite!");
157 return simcall_BODY_process_execute(name, flops_amount, priority, bound, affinity_mask);
161 * \ingroup simix_process_management
162 * \brief Creates a synchro that may involve parallel computation on
163 * several hosts and communication between them.
165 * \param name Name of the execution synchro to create
166 * \param host_nb Number of hosts where the synchro will be executed
167 * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
168 * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
169 * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
170 * amount between each pair of hosts
171 * \param amount the SURF action amount
172 * \param rate the SURF action rate
173 * \return A new SIMIX execution synchronization
175 smx_synchro_t simcall_process_parallel_execute(const char *name,
177 sg_host_t *host_list,
178 double *flops_amount,
179 double *bytes_amount,
184 /* checking for infinite values */
185 for (i = 0 ; i < host_nb ; ++i) {
186 xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
187 for (j = 0 ; j < host_nb ; ++j) {
188 xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
189 "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
193 xbt_assert(isfinite(amount), "amount is not finite!");
194 xbt_assert(isfinite(rate), "rate is not finite!");
196 return simcall_BODY_process_parallel_execute(name, host_nb, host_list,
204 * \ingroup simix_process_management
205 * \brief Destroys an execution synchro.
207 * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
208 * \param execution The execution synchro to destroy
210 void simcall_process_execution_destroy(smx_synchro_t execution)
212 simcall_BODY_process_execution_destroy(execution);
216 * \ingroup simix_process_management
217 * \brief Cancels an execution synchro.
219 * This functions stops the execution. It calls a surf function.
220 * \param execution The execution synchro to cancel
222 void simcall_process_execution_cancel(smx_synchro_t execution)
224 simcall_BODY_process_execution_cancel(execution);
228 * \ingroup simix_process_management
229 * \brief Returns how much of an execution synchro remains to be done.
231 * \param execution The execution synchro
232 * \return The remaining amount
234 double simcall_process_execution_get_remains(smx_synchro_t execution)
236 return simcall_BODY_process_execution_get_remains(execution);
240 * \ingroup simix_process_management
241 * \brief Returns the state of an execution synchro.
243 * \param execution The execution synchro
246 e_smx_state_t simcall_process_execution_get_state(smx_synchro_t execution)
248 return simcall_BODY_process_execution_get_state(execution);
252 * \ingroup simix_process_management
253 * \brief Changes the priority of an execution synchro.
255 * This functions changes the priority only. It calls a surf function.
256 * \param execution The execution synchro
257 * \param priority The new priority
259 void simcall_process_execution_set_priority(smx_synchro_t execution, double priority)
261 /* checking for infinite values */
262 xbt_assert(isfinite(priority), "priority is not finite!");
264 simcall_BODY_process_execution_set_priority(execution, priority);
268 * \ingroup simix_process_management
269 * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
271 * This functions changes the capping only. It calls a surf function.
272 * \param execution The execution synchro
273 * \param bound The new bound
275 void simcall_process_execution_set_bound(smx_synchro_t execution, double bound)
277 simcall_BODY_process_execution_set_bound(execution, bound);
281 * \ingroup simix_process_management
282 * \brief Changes the CPU affinity of an execution synchro.
284 * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
285 * \param execution The execution synchro
287 * \param mask Affinity mask
289 void simcall_process_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
291 simcall_BODY_process_execution_set_affinity(execution, host, mask);
295 * \ingroup simix_host_management
296 * \brief Waits for the completion of an execution synchro and destroy it.
298 * \param execution The execution synchro
300 e_smx_state_t simcall_process_execution_wait(smx_synchro_t execution)
302 return simcall_BODY_process_execution_wait(execution);
307 * \ingroup simix_vm_management
308 * \brief Create a VM on the given physical host.
310 * \param name VM name
311 * \param host Physical host
313 * \return The host object of the VM
315 void* simcall_vm_create(const char *name, sg_host_t phys_host){
316 return simcall_BODY_vm_create(name, phys_host);
320 * \ingroup simix_vm_management
321 * \brief Start the given VM to the given physical host
325 void simcall_vm_start(sg_host_t vm)
327 simcall_BODY_vm_start(vm);
331 * \ingroup simix_vm_management
332 * \brief Get the state of the given VM
335 * \return The state of the VM
337 int simcall_vm_get_state(sg_host_t vm)
339 return simcall_BODY_vm_get_state(vm);
343 * \ingroup simix_vm_management
344 * \brief Get the name of the physical host on which the given VM runs.
347 * \return The name of the physical host
349 void *simcall_vm_get_pm(sg_host_t vm)
351 return simcall_BODY_vm_get_pm(vm);
354 void simcall_vm_set_bound(sg_host_t vm, double bound)
356 simcall_BODY_vm_set_bound(vm, bound);
359 void simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask)
361 simcall_BODY_vm_set_affinity(vm, pm, mask);
364 void simcall_host_get_params(sg_host_t vm, vm_params_t params)
366 simcall_BODY_host_get_params(vm, params);
369 void simcall_host_set_params(sg_host_t vm, vm_params_t params)
371 simcall_BODY_host_set_params(vm, params);
375 * \ingroup simix_vm_management
376 * \brief Migrate the given VM to the given physical host
379 * \param host Destination physical host
381 void simcall_vm_migrate(sg_host_t vm, sg_host_t host)
383 simcall_BODY_vm_migrate(vm, host);
387 * \ingroup simix_vm_management
388 * \brief Suspend the given VM
392 void simcall_vm_suspend(sg_host_t vm)
394 simcall_BODY_vm_suspend(vm);
398 * \ingroup simix_vm_management
399 * \brief Resume the given VM
403 void simcall_vm_resume(sg_host_t vm)
405 simcall_BODY_vm_resume(vm);
409 * \ingroup simix_vm_management
410 * \brief Save the given VM
414 void simcall_vm_save(sg_host_t vm)
416 simcall_BODY_vm_save(vm);
420 * \ingroup simix_vm_management
421 * \brief Restore the given VM
425 void simcall_vm_restore(sg_host_t vm)
427 simcall_BODY_vm_restore(vm);
431 * \ingroup simix_vm_management
432 * \brief Shutdown the given VM
436 void simcall_vm_shutdown(sg_host_t vm)
438 simcall_BODY_vm_shutdown(vm);
442 * \ingroup simix_vm_management
443 * \brief Destroy the given VM
447 void simcall_vm_destroy(sg_host_t vm)
449 simcall_BODY_vm_destroy(vm);
453 * \ingroup simix_vm_management
454 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
455 * The simcall actually invokes the following calls:
456 * simcall_vm_set_affinity(vm, src_pm, 0);
457 * simcall_vm_migrate(vm, dst_pm);
458 * simcall_vm_resume(vm);
460 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
462 * \param vm VM to migrate
463 * \param src_pm Source physical host
464 * \param dst_pmt Destination physical host
466 void simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
468 simcall_BODY_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
472 * \ingroup simix_process_management
473 * \brief Creates and runs a new SIMIX process.
475 * The structure and the corresponding thread are created and put in the list of ready processes.
477 * \param name a name for the process. It is for user-level information and can be NULL.
478 * \param code the main function of the process
479 * \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.
480 * It can be retrieved with the function \ref simcall_process_get_data.
481 * \param hostname name of the host where the new agent is executed.
482 * \param kill_time time when the process is killed
483 * \param argc first argument passed to \a code
484 * \param argv second argument passed to \a code
485 * \param properties the properties of the process
486 * \param auto_restart either it is autorestarting or not.
488 smx_process_t simcall_process_create(const char *name,
489 xbt_main_func_t code,
491 const char *hostname,
493 int argc, char **argv,
494 xbt_dict_t properties,
497 return (smx_process_t) simcall_BODY_process_create(name, code, data, hostname,
498 kill_time, argc, argv, properties,
503 * \ingroup simix_process_management
504 * \brief Kills a SIMIX process.
506 * This function simply kills a process.
508 * \param process poor victim
510 void simcall_process_kill(smx_process_t process)
512 simcall_BODY_process_kill(process);
516 * \ingroup simix_process_management
517 * \brief Kills all SIMIX processes.
519 void simcall_process_killall(int reset_pid)
521 simcall_BODY_process_killall(reset_pid);
525 * \ingroup simix_process_management
526 * \brief Cleans up a SIMIX process.
527 * \param process poor victim (must have already been killed)
529 void simcall_process_cleanup(smx_process_t process)
531 simcall_BODY_process_cleanup(process);
535 * \ingroup simix_process_management
536 * \brief Migrates an agent to another location.
538 * This function changes the value of the host on which \a process is running.
540 * \param process the process to migrate
541 * \param dest name of the new host
543 void simcall_process_set_host(smx_process_t process, sg_host_t dest)
545 simcall_BODY_process_set_host(process, dest);
548 void simcall_process_join(smx_process_t process, double timeout)
550 simcall_BODY_process_join(process, timeout);
554 * \ingroup simix_process_management
555 * \brief Suspends a process.
557 * This function suspends the process by suspending the synchro
558 * it was waiting for completion.
560 * \param process a SIMIX process
562 void simcall_process_suspend(smx_process_t process)
564 xbt_assert(process, "Invalid parameters");
566 simcall_BODY_process_suspend(process);
570 * \ingroup simix_process_management
571 * \brief Resumes a suspended process.
573 * This function resumes a suspended process by resuming the synchro
574 * it was waiting for completion.
576 * \param process a SIMIX process
578 void simcall_process_resume(smx_process_t process)
580 simcall_BODY_process_resume(process);
584 * \ingroup simix_process_management
585 * \brief Returns the amount of SIMIX processes in the system
587 * Maestro internal process is not counted, only user code processes are
589 int simcall_process_count(void)
591 return simcall_BODY_process_count();
595 * \ingroup simix_process_management
596 * \brief Return the PID of a #smx_process_t.
597 * \param process a SIMIX process
598 * \return the PID of this process
600 int simcall_process_get_PID(smx_process_t process)
602 if (process == SIMIX_process_self()) {
603 /* avoid a simcall if this function is called by the process itself */
604 return SIMIX_process_get_PID(process);
607 return simcall_BODY_process_get_PID(process);
611 * \ingroup simix_process_management
612 * \brief Return the parent PID of a #smx_process_t.
613 * \param process a SIMIX process
614 * \return the PID of this process parenrt
616 int simcall_process_get_PPID(smx_process_t process)
618 if (process == SIMIX_process_self()) {
619 /* avoid a simcall if this function is called by the process itself */
620 return SIMIX_process_get_PPID(process);
623 return simcall_BODY_process_get_PPID(process);
627 * \ingroup simix_process_management
628 * \brief Return the user data of a #smx_process_t.
629 * \param process a SIMIX process
630 * \return the user data of this process
632 void* simcall_process_get_data(smx_process_t process)
634 if (process == SIMIX_process_self()) {
635 /* avoid a simcall if this function is called by the process itself */
636 return SIMIX_process_get_data(process);
639 return simcall_BODY_process_get_data(process);
643 * \ingroup simix_process_management
644 * \brief Set the user data of a #smx_process_t.
646 * This functions sets the user data associated to \a process.
647 * \param process SIMIX process
648 * \param data User data
650 void simcall_process_set_data(smx_process_t process, void *data)
652 if (process == SIMIX_process_self()) {
653 /* avoid a simcall if this function is called by the process itself */
654 SIMIX_process_self_set_data(process, data);
657 simcall_BODY_process_set_data(process, data);
662 * \ingroup simix_process_management
663 * \brief Set the kill time of a process.
665 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
668 if (kill_time > SIMIX_get_clock()) {
669 if (simix_global->kill_process_function) {
670 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
671 sg_host_get_name(process->host));
672 process->kill_timer = SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
677 * \ingroup simix_process_management
678 * \brief Get the kill time of a process (or 0 if unset).
680 double simcall_process_get_kill_time(smx_process_t process) {
681 return SIMIX_timer_get_date(process->kill_timer);
685 * \ingroup simix_process_management
686 * \brief Return the location on which an agent is running.
688 * This functions returns the sg_host_t corresponding to the location on which
689 * \a process is running.
690 * \param process SIMIX process
693 sg_host_t simcall_process_get_host(smx_process_t process)
695 return simcall_BODY_process_get_host(process);
699 * \ingroup simix_process_management
700 * \brief Return the name of an agent.
702 * This functions checks whether \a process is a valid pointer or not and return its name.
703 * \param process SIMIX process
704 * \return The process name
706 const char* simcall_process_get_name(smx_process_t process)
708 if (process == SIMIX_process_self()) {
709 /* avoid a simcall if this function is called by the process itself */
710 return process->name;
712 return simcall_BODY_process_get_name(process);
716 * \ingroup simix_process_management
717 * \brief Returns true if the process is suspended .
719 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
720 * \param process SIMIX process
721 * \return 1, if the process is suspended, else 0.
723 int simcall_process_is_suspended(smx_process_t process)
725 return simcall_BODY_process_is_suspended(process);
729 * \ingroup simix_process_management
730 * \brief Return the properties
732 * This functions returns the properties associated with this process
734 xbt_dict_t simcall_process_get_properties(smx_process_t process)
736 return simcall_BODY_process_get_properties(process);
739 * \ingroup simix_process_management
740 * \brief Add an on_exit function
741 * Add an on_exit function which will be executed when the process exits/is killed.
743 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
745 simcall_BODY_process_on_exit(process, fun, data);
748 * \ingroup simix_process_management
749 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
750 * Will restart the process when the host comes back up if auto_restart is set to 1.
753 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
755 simcall_BODY_process_auto_restart_set(process, auto_restart);
759 * \ingroup simix_process_management
760 * \brief Restarts the process, killing it and starting it again from scratch.
762 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
764 return simcall_BODY_process_restart(process);
767 * \ingroup simix_process_management
768 * \brief Creates a new sleep SIMIX synchro.
770 * This function creates a SURF action and allocates the data necessary
771 * to create the SIMIX synchro. It can raise a host_error exception if the
772 * host crashed. The default SIMIX name of the synchro is "sleep".
774 * \param duration Time duration of the sleep.
775 * \return A result telling whether the sleep was successful
777 e_smx_state_t simcall_process_sleep(double duration)
779 /* checking for infinite values */
780 xbt_assert(isfinite(duration), "duration is not finite!");
781 return simcall_BODY_process_sleep(duration);
785 * \ingroup simix_rdv_management
786 * \brief Creates a new rendez-vous point
787 * \param name The name of the rendez-vous point
788 * \return The created rendez-vous point
790 smx_rdv_t simcall_rdv_create(const char *name)
792 return simcall_BODY_rdv_create(name);
797 * \ingroup simix_rdv_management
798 * \brief Destroy a rendez-vous point
799 * \param rdv The rendez-vous point to destroy
801 void simcall_rdv_destroy(smx_rdv_t rdv)
803 simcall_BODY_rdv_destroy(rdv);
806 * \ingroup simix_rdv_management
807 * \brief Returns a rendez-vous point knowing its name
809 smx_rdv_t simcall_rdv_get_by_name(const char *name)
811 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
813 /* FIXME: this is a horrible loss of performance, so we hack it out by
814 * skipping the simcall (for now). It works in parallel, it won't work on
815 * distributed but probably we will change MSG for that. */
817 return SIMIX_rdv_get_by_name(name);
821 * \ingroup simix_rdv_management
822 * \brief Counts the number of communication synchros of a given host pending
823 * on a rendez-vous point.
824 * \param rdv The rendez-vous point
825 * \param host The host to be counted
826 * \return The number of comm synchros pending in the rdv
828 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
830 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
834 * \ingroup simix_rdv_management
835 * \brief returns the communication at the head of the rendez-vous
836 * \param rdv The rendez-vous point
837 * \return The communication or NULL if empty
839 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
841 return simcall_BODY_rdv_get_head(rdv);
844 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
846 simcall_BODY_rdv_set_receiver(rdv, process);
849 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
851 return simcall_BODY_rdv_get_receiver(rdv);
855 * \ingroup simix_comm_management
857 void simcall_comm_send(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
858 void *src_buff, size_t src_buff_size,
859 int (*match_fun)(void *, void *, smx_synchro_t),
860 void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
863 /* checking for infinite values */
864 xbt_assert(isfinite(task_size), "task_size is not finite!");
865 xbt_assert(isfinite(rate), "rate is not finite!");
866 xbt_assert(isfinite(timeout), "timeout is not finite!");
868 xbt_assert(rdv, "No rendez-vous point defined for send");
870 if (MC_is_active() || MC_record_replay_is_active()) {
871 /* the model-checker wants two separate simcalls */
872 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
873 comm = simcall_comm_isend(sender, rdv, task_size, rate,
874 src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
875 simcall_comm_wait(comm, timeout);
879 simcall_BODY_comm_send(sender, rdv, task_size, rate, src_buff, src_buff_size,
880 match_fun, copy_data_fun, data, timeout);
885 * \ingroup simix_comm_management
887 smx_synchro_t simcall_comm_isend(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
888 void *src_buff, size_t src_buff_size,
889 int (*match_fun)(void *, void *, smx_synchro_t),
890 void (*clean_fun)(void *),
891 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
895 /* checking for infinite values */
896 xbt_assert(isfinite(task_size), "task_size is not finite!");
897 xbt_assert(isfinite(rate), "rate is not finite!");
899 xbt_assert(rdv, "No rendez-vous point defined for isend");
901 return simcall_BODY_comm_isend(sender, rdv, task_size, rate, src_buff,
902 src_buff_size, match_fun,
903 clean_fun, copy_data_fun, data, detached);
907 * \ingroup simix_comm_management
909 void simcall_comm_recv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
910 int (*match_fun)(void *, void *, smx_synchro_t),
911 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
912 void *data, double timeout, double rate)
914 xbt_assert(isfinite(timeout), "timeout is not finite!");
915 xbt_assert(rdv, "No rendez-vous point defined for recv");
917 if (MC_is_active() || MC_record_replay_is_active()) {
918 /* the model-checker wants two separate simcalls */
919 smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
920 comm = simcall_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
921 match_fun, copy_data_fun, data, rate);
922 simcall_comm_wait(comm, timeout);
926 simcall_BODY_comm_recv(receiver, rdv, dst_buff, dst_buff_size,
927 match_fun, copy_data_fun, data, timeout, rate);
931 * \ingroup simix_comm_management
933 smx_synchro_t simcall_comm_irecv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
934 int (*match_fun)(void *, void *, smx_synchro_t),
935 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
936 void *data, double rate)
938 xbt_assert(rdv, "No rendez-vous point defined for irecv");
940 return simcall_BODY_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
941 match_fun, copy_data_fun, data, rate);
945 * \ingroup simix_comm_management
947 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
948 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
950 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
952 return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
956 * \ingroup simix_comm_management
958 void simcall_comm_cancel(smx_synchro_t comm)
960 simcall_BODY_comm_cancel(comm);
964 * \ingroup simix_comm_management
966 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
968 return simcall_BODY_comm_waitany(comms);
972 * \ingroup simix_comm_management
974 int simcall_comm_testany(xbt_dynar_t comms)
976 if (xbt_dynar_is_empty(comms))
978 return simcall_BODY_comm_testany(comms);
982 * \ingroup simix_comm_management
984 void simcall_comm_wait(smx_synchro_t comm, double timeout)
986 xbt_assert(isfinite(timeout), "timeout is not finite!");
987 simcall_BODY_comm_wait(comm, timeout);
991 * \brief Set the category of an synchro.
993 * This functions changes the category only. It calls a surf function.
994 * \param execution The execution synchro
995 * \param category The tracing category
997 void simcall_set_category(smx_synchro_t synchro, const char *category)
999 if (category == NULL) {
1002 simcall_BODY_set_category(synchro, category);
1006 * \ingroup simix_comm_management
1009 int simcall_comm_test(smx_synchro_t comm)
1011 return simcall_BODY_comm_test(comm);
1015 * \ingroup simix_comm_management
1018 double simcall_comm_get_remains(smx_synchro_t comm)
1020 return simcall_BODY_comm_get_remains(comm);
1024 * \ingroup simix_comm_management
1027 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1029 return simcall_BODY_comm_get_state(comm);
1033 * \ingroup simix_comm_management
1036 void *simcall_comm_get_src_data(smx_synchro_t comm)
1038 return simcall_BODY_comm_get_src_data(comm);
1042 * \ingroup simix_comm_management
1045 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1047 return simcall_BODY_comm_get_dst_data(comm);
1051 * \ingroup simix_comm_management
1054 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1056 return simcall_BODY_comm_get_src_proc(comm);
1060 * \ingroup simix_comm_management
1063 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1065 return simcall_BODY_comm_get_dst_proc(comm);
1068 #ifdef HAVE_LATENCY_BOUND_TRACKING
1069 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1071 return simcall_BODY_comm_is_latency_bounded(comm);
1076 * \ingroup simix_synchro_management
1079 smx_mutex_t simcall_mutex_init(void)
1082 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
1085 return simcall_BODY_mutex_init();
1089 * \ingroup simix_synchro_management
1092 void simcall_mutex_destroy(smx_mutex_t mutex)
1094 simcall_BODY_mutex_destroy(mutex);
1098 * \ingroup simix_synchro_management
1101 void simcall_mutex_lock(smx_mutex_t mutex)
1103 simcall_BODY_mutex_lock(mutex);
1107 * \ingroup simix_synchro_management
1110 int simcall_mutex_trylock(smx_mutex_t mutex)
1112 return simcall_BODY_mutex_trylock(mutex);
1116 * \ingroup simix_synchro_management
1119 void simcall_mutex_unlock(smx_mutex_t mutex)
1121 simcall_BODY_mutex_unlock(mutex);
1125 * \ingroup simix_synchro_management
1128 smx_cond_t simcall_cond_init(void)
1130 return simcall_BODY_cond_init();
1134 * \ingroup simix_synchro_management
1137 void simcall_cond_destroy(smx_cond_t cond)
1139 simcall_BODY_cond_destroy(cond);
1143 * \ingroup simix_synchro_management
1146 void simcall_cond_signal(smx_cond_t cond)
1148 simcall_BODY_cond_signal(cond);
1152 * \ingroup simix_synchro_management
1155 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1157 simcall_BODY_cond_wait(cond, mutex);
1161 * \ingroup simix_synchro_management
1164 void simcall_cond_wait_timeout(smx_cond_t cond,
1168 xbt_assert(isfinite(timeout), "timeout is not finite!");
1169 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1173 * \ingroup simix_synchro_management
1176 void simcall_cond_broadcast(smx_cond_t cond)
1178 simcall_BODY_cond_broadcast(cond);
1182 * \ingroup simix_synchro_management
1185 smx_sem_t simcall_sem_init(int capacity)
1187 return simcall_BODY_sem_init(capacity);
1191 * \ingroup simix_synchro_management
1194 void simcall_sem_destroy(smx_sem_t sem)
1196 simcall_BODY_sem_destroy(sem);
1200 * \ingroup simix_synchro_management
1203 void simcall_sem_release(smx_sem_t sem)
1205 simcall_BODY_sem_release(sem);
1209 * \ingroup simix_synchro_management
1212 int simcall_sem_would_block(smx_sem_t sem)
1214 return simcall_BODY_sem_would_block(sem);
1218 * \ingroup simix_synchro_management
1221 void simcall_sem_acquire(smx_sem_t sem)
1223 simcall_BODY_sem_acquire(sem);
1227 * \ingroup simix_synchro_management
1230 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1232 xbt_assert(isfinite(timeout), "timeout is not finite!");
1233 simcall_BODY_sem_acquire_timeout(sem, timeout);
1237 * \ingroup simix_synchro_management
1240 int simcall_sem_get_capacity(smx_sem_t sem)
1242 return simcall_BODY_sem_get_capacity(sem);
1246 * \ingroup simix_file_management
1249 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1251 return simcall_BODY_file_read(fd, size, host);
1255 * \ingroup simix_file_management
1258 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1260 return simcall_BODY_file_write(fd, size, host);
1264 * \ingroup simix_file_management
1267 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1269 return simcall_BODY_file_open(fullpath, host);
1273 * \ingroup simix_file_management
1276 int simcall_file_close(smx_file_t fd, sg_host_t host)
1278 return simcall_BODY_file_close(fd, host);
1282 * \ingroup simix_file_management
1285 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1287 return simcall_BODY_file_unlink(fd, host);
1291 * \ingroup simix_file_management
1294 sg_size_t simcall_file_get_size(smx_file_t fd){
1295 return simcall_BODY_file_get_size(fd);
1299 * \ingroup simix_file_management
1302 sg_size_t simcall_file_tell(smx_file_t fd){
1303 return simcall_BODY_file_tell(fd);
1307 * \ingroup simix_file_management
1310 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1312 return simcall_BODY_file_get_info(fd);
1316 * \ingroup simix_file_management
1319 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1320 return simcall_BODY_file_seek(fd, offset, origin);
1324 * \ingroup simix_file_management
1325 * \brief Move a file to another location on the *same mount point*.
1328 int simcall_file_move(smx_file_t fd, const char* fullpath)
1330 return simcall_BODY_file_move(fd, fullpath);
1334 * \ingroup simix_storage_management
1335 * \brief Returns the free space size on a given storage element.
1336 * \param storage a storage
1337 * \return Return the free space size on a given storage element (as sg_size_t)
1339 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1340 return simcall_BODY_storage_get_free_size(storage);
1344 * \ingroup simix_storage_management
1345 * \brief Returns the used space size on a given storage element.
1346 * \param storage a storage
1347 * \return Return the used space size on a given storage element (as sg_size_t)
1349 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1350 return simcall_BODY_storage_get_used_size(storage);
1354 * \ingroup simix_storage_management
1355 * \brief Returns the list of storages mounted on an host.
1356 * \param host A SIMIX host
1357 * \return a dict containing all storages mounted on the host
1359 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
1361 return simcall_BODY_host_get_mounted_storage_list(host);
1365 * \ingroup simix_storage_management
1366 * \brief Returns the list of storages attached to an host.
1367 * \param host A SIMIX host
1368 * \return a dict containing all storages attached to the host
1370 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
1372 return simcall_BODY_host_get_attached_storage_list(host);
1376 * \ingroup simix_storage_management
1377 * \brief Returns a dict of the properties assigned to a storage element.
1379 * \param storage A storage element
1380 * \return The properties of this storage element
1382 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1384 return simcall_BODY_storage_get_properties(storage);
1388 * \ingroup simix_storage_management
1389 * \brief Returns a dict containing the content of a storage element.
1391 * \param storage A storage element
1392 * \return The content of this storage element as a dict (full path file => size)
1394 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1396 return simcall_BODY_storage_get_content(storage);
1403 void *simcall_mc_snapshot(void) {
1404 return simcall_BODY_mc_snapshot();
1407 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1408 return simcall_BODY_mc_compare_snapshots(s1, s2);
1411 #endif /* HAVE_MC */
1413 int simcall_mc_random(int min, int max) {
1414 return simcall_BODY_mc_random(min, max);
1417 /* ************************************************************************** */
1419 /** @brief returns a printable string representing a simcall */
1420 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1421 return simcall_names[kind];