1 /* smx_user.c - public interface to simix */
3 /* Copyright (c) 2010-2014. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "smx_private.h"
12 #include <math.h> /* isfinite() */
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
16 /* generate strings from the enumeration values */
17 static const char* simcall_names[] = {
18 #include "simcalls_generated_string.c"
19 [SIMCALL_NONE] = "NONE"
22 #include "simcalls_generated_body.c"
25 * \ingroup simix_host_management
26 * \brief Returns a host given its name.
28 * \param name The name of the host to get
29 * \return The corresponding host
31 smx_host_t simcall_host_get_by_name(const char *name)
33 return simcall_BODY_host_get_by_name(name);
37 * \ingroup simix_host_management
38 * \brief Returns the name of a host.
40 * \param host A SIMIX host
41 * \return The name of this host
43 const char* simcall_host_get_name(smx_host_t host)
45 return simcall_BODY_host_get_name(host);
49 * \ingroup simix_host_management
50 * \brief Start the host if it is off
52 * \param host A SIMIX host
54 void simcall_host_on(smx_host_t host)
56 simcall_BODY_host_on(host);
60 * \ingroup simix_host_management
61 * \brief Stop the host if it is on
63 * \param host A SIMIX host
65 void simcall_host_off(smx_host_t host)
67 simcall_BODY_host_off(host);
71 * \ingroup simix_host_management
72 * \brief Returns a dict of the properties assigned to a host.
75 * \return The properties of this host
77 xbt_dict_t simcall_host_get_properties(smx_host_t host)
79 return simcall_BODY_host_get_properties(host);
83 * \ingroup simix_host_management
84 * \brief Returns a dict of the properties assigned to a router or AS.
86 * \param name The name of the router or AS
87 * \return The properties
89 xbt_dict_t simcall_asr_get_properties(const char *name)
91 return simcall_BODY_asr_get_properties(name);
96 * \ingroup simix_host_management
97 * \brief Returns the speed of the processor.
99 * The speed returned does not take into account the current load on the machine.
100 * \param host A SIMIX host
101 * \return The speed of this host (in Mflop/s)
103 double simcall_host_get_speed(smx_host_t host)
105 return simcall_BODY_host_get_speed(host);
109 * \ingroup simix_host_management
110 * \brief Returns the number of core of the processor.
112 * \param host A SIMIX host
113 * \return The number of core
115 int simcall_host_get_core(smx_host_t host)
117 return simcall_BODY_host_get_core(host);
121 * \ingroup simix_host_management
122 * \brief Returns the list of processes attached to the host.
124 * \param host A SIMIX host
125 * \return the swag of attached processes
127 xbt_swag_t simcall_host_get_process_list(smx_host_t host)
129 return simcall_BODY_host_get_process_list(host);
134 * \ingroup simix_host_management
135 * \brief Returns the available speed of the processor.
137 * \return Speed currently available (in Mflop/s)
139 double simcall_host_get_available_speed(smx_host_t host)
141 return simcall_BODY_host_get_available_speed(host);
145 * \ingroup simix_host_management
146 * \brief Returns the state of a host.
148 * Two states are possible: 1 if the host is active or 0 if it has crashed.
149 * \param host A SIMIX host
150 * \return 1 if the host is available, 0 otherwise
152 int simcall_host_get_state(smx_host_t host)
154 return simcall_BODY_host_get_state(host);
158 * \ingroup simix_host_management
159 * \brief Returns the power peak of a host.
161 * \param host A SIMIX host
162 * \return the current power peak value (double)
164 double simcall_host_get_current_power_peak(smx_host_t host)
166 return simcall_BODY_host_get_current_power_peak(host);
170 * \ingroup simix_host_management
171 * \brief Returns one power peak (in flops/s) of a host at a given pstate
173 * \param host A SIMIX host
174 * \param pstate_index pstate to test
175 * \return the current power peak value (double) for pstate_index
177 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
179 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
183 * \ingroup simix_host_management
184 * \brief Returns the number of power states for a host.
186 * \param host A SIMIX host
187 * \return the number of power states
189 int simcall_host_get_nb_pstates(smx_host_t host)
191 return simcall_BODY_host_get_nb_pstates(host);
195 * \ingroup simix_host_management
196 * \brief Sets a new power peak for a host.
198 * \param host A SIMIX host
199 * \param pstate_index The pstate to which the CPU power will be set
202 void simcall_host_set_power_peak_at(smx_host_t host, int pstate_index)
204 simcall_BODY_host_set_power_peak_at(host, pstate_index);
208 * \ingroup simix_host_management
209 * \brief Returns the total energy consumed by the host (in Joules)
211 * \param host A SIMIX host
212 * \return the energy consumed by the host (double)
214 double simcall_host_get_consumed_energy(smx_host_t host)
216 return simcall_BODY_host_get_consumed_energy(host);
221 * \ingroup simix_host_management
222 * \brief Creates an action that executes some computation of an host.
224 * This function creates a SURF action and allocates the data necessary
225 * to create the SIMIX action. It can raise a host_error exception if the host crashed.
227 * \param name Name of the execution action to create
228 * \param host SIMIX host where the action will be executed
229 * \param computation_amount amount Computation amount (in bytes)
230 * \param priority computation priority
232 * \param affinity_mask
233 * \return A new SIMIX execution action
235 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
236 double computation_amount,
237 double priority, double bound, unsigned long affinity_mask)
239 /* checking for infinite values */
240 xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
241 xbt_assert(isfinite(priority), "priority is not finite!");
243 return simcall_BODY_host_execute(name, host, computation_amount, priority, bound, affinity_mask);
247 * \ingroup simix_host_management
248 * \brief Creates an action that may involve parallel computation on
249 * several hosts and communication between them.
251 * \param name Name of the execution action to create
252 * \param host_nb Number of hosts where the action will be executed
253 * \param host_list Array (of size host_nb) of hosts where the action will be executed
254 * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
255 * \param communication_amount Array (of size host_nb * host_nb) representing the communication
256 * amount between each pair of hosts
257 * \param amount the SURF action amount
258 * \param rate the SURF action rate
259 * \return A new SIMIX execution action
261 smx_action_t simcall_host_parallel_execute(const char *name,
263 smx_host_t *host_list,
264 double *computation_amount,
265 double *communication_amount,
270 /* checking for infinite values */
271 for (i = 0 ; i < host_nb ; ++i) {
272 xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
273 for (j = 0 ; j < host_nb ; ++j) {
274 xbt_assert(isfinite(communication_amount[i + host_nb * j]),
275 "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
279 xbt_assert(isfinite(amount), "amount is not finite!");
280 xbt_assert(isfinite(rate), "rate is not finite!");
282 return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
284 communication_amount,
290 * \ingroup simix_host_management
291 * \brief Destroys an execution action.
293 * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
294 * \param execution The execution action to destroy
296 void simcall_host_execution_destroy(smx_action_t execution)
298 simcall_BODY_host_execution_destroy(execution);
302 * \ingroup simix_host_management
303 * \brief Cancels an execution action.
305 * This functions stops the execution. It calls a surf function.
306 * \param execution The execution action to cancel
308 void simcall_host_execution_cancel(smx_action_t execution)
310 simcall_BODY_host_execution_cancel(execution);
314 * \ingroup simix_host_management
315 * \brief Returns how much of an execution action remains to be done.
317 * \param execution The execution action
318 * \return The remaining amount
320 double simcall_host_execution_get_remains(smx_action_t execution)
322 return simcall_BODY_host_execution_get_remains(execution);
326 * \ingroup simix_host_management
327 * \brief Returns the state of an execution action.
329 * \param execution The execution action
332 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
334 return simcall_BODY_host_execution_get_state(execution);
338 * \ingroup simix_host_management
339 * \brief Changes the priority of an execution action.
341 * This functions changes the priority only. It calls a surf function.
342 * \param execution The execution action
343 * \param priority The new priority
345 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
347 /* checking for infinite values */
348 xbt_assert(isfinite(priority), "priority is not finite!");
350 simcall_BODY_host_execution_set_priority(execution, priority);
354 * \ingroup simix_host_management
355 * \brief Changes the capping (the maximum CPU utilization) of an execution action.
357 * This functions changes the capping only. It calls a surf function.
358 * \param execution The execution action
359 * \param bound The new bound
361 void simcall_host_execution_set_bound(smx_action_t execution, double bound)
363 simcall_BODY_host_execution_set_bound(execution, bound);
367 * \ingroup simix_host_management
368 * \brief Changes the CPU affinity of an execution action.
370 * This functions changes the CPU affinity of an execution action. See taskset(1) on Linux.
371 * \param execution The execution action
373 * \param mask Affinity mask
375 void simcall_host_execution_set_affinity(smx_action_t execution, smx_host_t host, unsigned long mask)
377 simcall_BODY_host_execution_set_affinity(execution, host, mask);
381 * \ingroup simix_host_management
382 * \brief Waits for the completion of an execution action and destroy it.
384 * \param execution The execution action
386 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
388 return simcall_BODY_host_execution_wait(execution);
393 * \ingroup simix_vm_management
394 * \brief Create a VM on the given physical host.
396 * \param name VM name
397 * \param host Physical host
399 * \return The host object of the VM
401 void* simcall_vm_create(const char *name, smx_host_t phys_host){
402 /* will jump to SIMIX_pre_vm_create() in src/simix/smx_smurf_private.h */
403 return simcall_BODY_vm_create(name, phys_host);
407 * \ingroup simix_vm_management
408 * \brief Start the given VM to the given physical host
412 void simcall_vm_start(smx_host_t vm)
414 /* will jump to SIMIX_pre_vm_start in src/simix/smx_smurf_private.h */
415 simcall_BODY_vm_start(vm);
419 * \ingroup simix_vm_management
420 * \brief Get the state of the given VM
423 * \return The state of the VM
425 int simcall_vm_get_state(smx_host_t vm)
427 /* will jump to SIMIX_pre_vm_get_state in src/simix/smx_smurf_private.h */
428 return simcall_BODY_vm_get_state(vm);
432 * \ingroup simix_vm_management
433 * \brief Get the name of the physical host on which the given VM runs.
436 * \return The name of the physical host
438 void *simcall_vm_get_pm(smx_host_t vm)
440 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
441 return simcall_BODY_vm_get_pm(vm);
444 void simcall_vm_set_bound(smx_host_t vm, double bound)
446 /* will jump to SIMIX_pre_vm_set_bound in src/simix/smx_smurf_private.h */
447 simcall_BODY_vm_set_bound(vm, bound);
450 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
452 /* will jump to SIMIX_pre_vm_set_affinity in src/simix/smx_smurf_private.h */
453 simcall_BODY_vm_set_affinity(vm, pm, mask);
456 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
458 /* will jump to SIMIX_pre_host_get_params in src/simix/smx_smurf_private.h */
459 simcall_BODY_host_get_params(vm, params);
462 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
464 /* will jump to SIMIX_pre_host_set_params in src/simix/smx_smurf_private.h */
465 simcall_BODY_host_set_params(vm, params);
469 * \ingroup simix_vm_management
470 * \brief Migrate the given VM to the given physical host
473 * \param host Destination physical host
475 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
477 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
478 simcall_BODY_vm_migrate(vm, host);
482 * \ingroup simix_vm_management
483 * \brief Suspend the given VM
487 void simcall_vm_suspend(smx_host_t vm)
489 /* will jump to SIMIX_pre_vm_suspend in src/simix/smx_smurf_private.h */
490 simcall_BODY_vm_suspend(vm);
494 * \ingroup simix_vm_management
495 * \brief Resume the given VM
499 void simcall_vm_resume(smx_host_t vm)
501 /* will jump to SIMIX_pre_vm_resume in src/simix/smx_smurf_private.h */
502 simcall_BODY_vm_resume(vm);
506 * \ingroup simix_vm_management
507 * \brief Save the given VM
511 void simcall_vm_save(smx_host_t vm)
513 /* will jump to SIMIX_pre_vm_save in src/simix/smx_smurf_private.h */
514 simcall_BODY_vm_save(vm);
518 * \ingroup simix_vm_management
519 * \brief Restore the given VM
523 void simcall_vm_restore(smx_host_t vm)
525 /* will jump to SIMIX_pre_vm_restore in src/simix/smx_smurf_private.h */
526 simcall_BODY_vm_restore(vm);
530 * \ingroup simix_vm_management
531 * \brief Shutdown the given VM
535 void simcall_vm_shutdown(smx_host_t vm)
537 /* will jump to SIMIX_pre_vm_shutdown in src/simix/smx_smurf_private.h */
538 simcall_BODY_vm_shutdown(vm);
542 * \ingroup simix_vm_management
543 * \brief Destroy the given VM
547 void simcall_vm_destroy(smx_host_t vm)
549 /* will jump to SIMIX_pre_vm_destroy in src/simix/smx_smurf_private.h */
550 simcall_BODY_vm_destroy(vm);
555 * \ingroup simix_process_management
556 * \brief Creates and runs a new SIMIX process.
558 * The structure and the corresponding thread are created and put in the list of ready processes.
560 * \param process the process created will be stored in this pointer
561 * \param name a name for the process. It is for user-level information and can be NULL.
562 * \param code the main function of the process
563 * \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.
564 * It can be retrieved with the function \ref simcall_process_get_data.
565 * \param hostname name of the host where the new agent is executed.
566 * \param kill_time time when the process is killed
567 * \param argc first argument passed to \a code
568 * \param argv second argument passed to \a code
569 * \param properties the properties of the process
570 * \param auto_restart either it is autorestarting or not.
572 void simcall_process_create(smx_process_t *process, const char *name,
573 xbt_main_func_t code,
575 const char *hostname,
577 int argc, char **argv,
578 xbt_dict_t properties,
581 simcall_BODY_process_create(process, name, code, data, hostname,
582 kill_time, argc, argv, properties,
587 * \ingroup simix_process_management
588 * \brief Kills a SIMIX process.
590 * This function simply kills a process.
592 * \param process poor victim
594 void simcall_process_kill(smx_process_t process)
596 simcall_BODY_process_kill(process);
600 * \ingroup simix_process_management
601 * \brief Kills all SIMIX processes.
603 void simcall_process_killall(int reset_pid)
605 simcall_BODY_process_killall(reset_pid);
609 * \ingroup simix_process_management
610 * \brief Cleans up a SIMIX process.
611 * \param process poor victim (must have already been killed)
613 void simcall_process_cleanup(smx_process_t process)
615 simcall_BODY_process_cleanup(process);
619 * \ingroup simix_process_management
620 * \brief Migrates an agent to another location.
622 * This function changes the value of the host on which \a process is running.
624 * \param process the process to migrate
625 * \param dest name of the new host
627 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
629 simcall_BODY_process_change_host(process, dest);
633 * \ingroup simix_process_management
634 * \brief Suspends a process.
636 * This function suspends the process by suspending the action
637 * it was waiting for completion.
639 * \param process a SIMIX process
641 void simcall_process_suspend(smx_process_t process)
643 xbt_assert(process, "Invalid parameters");
645 simcall_BODY_process_suspend(process);
649 * \ingroup simix_process_management
650 * \brief Resumes a suspended process.
652 * This function resumes a suspended process by resuming the action
653 * it was waiting for completion.
655 * \param process a SIMIX process
657 void simcall_process_resume(smx_process_t process)
659 simcall_BODY_process_resume(process);
663 * \ingroup simix_process_management
664 * \brief Returns the amount of SIMIX processes in the system
666 * Maestro internal process is not counted, only user code processes are
668 int simcall_process_count(void)
670 return simcall_BODY_process_count();
674 * \ingroup simix_process_management
675 * \brief Return the PID of a #smx_process_t.
676 * \param process a SIMIX process
677 * \return the PID of this process
679 int simcall_process_get_PID(smx_process_t process)
681 if (process == SIMIX_process_self()) {
682 /* avoid a simcall if this function is called by the process itself */
683 return SIMIX_process_get_PID(process);
686 return simcall_BODY_process_get_PID(process);
690 * \ingroup simix_process_management
691 * \brief Return the parent PID of a #smx_process_t.
692 * \param process a SIMIX process
693 * \return the PID of this process parenrt
695 int simcall_process_get_PPID(smx_process_t process)
697 if (process == SIMIX_process_self()) {
698 /* avoid a simcall if this function is called by the process itself */
699 return SIMIX_process_get_PPID(process);
702 return simcall_BODY_process_get_PPID(process);
706 * \ingroup simix_process_management
707 * \brief Return the user data of a #smx_process_t.
708 * \param process a SIMIX process
709 * \return the user data of this process
711 void* simcall_process_get_data(smx_process_t process)
713 if (process == SIMIX_process_self()) {
714 /* avoid a simcall if this function is called by the process itself */
715 return SIMIX_process_get_data(process);
718 return simcall_BODY_process_get_data(process);
722 * \ingroup simix_process_management
723 * \brief Set the user data of a #smx_process_t.
725 * This functions sets the user data associated to \a process.
726 * \param process SIMIX process
727 * \param data User data
729 void simcall_process_set_data(smx_process_t process, void *data)
731 if (process == SIMIX_process_self()) {
732 /* avoid a simcall if this function is called by the process itself */
733 SIMIX_process_self_set_data(process, data);
736 simcall_BODY_process_set_data(process, data);
741 * \ingroup simix_process_management
742 * \brief Set the kill time of a process.
743 * \param process a process
744 * \param kill_time a double
746 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
749 if (kill_time > SIMIX_get_clock()) {
750 if (simix_global->kill_process_function) {
751 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
752 sg_host_name(process->smx_host));
753 SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
759 * \ingroup simix_process_management
760 * \brief Return the location on which an agent is running.
762 * This functions returns the smx_host_t corresponding to the location on which
763 * \a process is running.
764 * \param process SIMIX process
767 smx_host_t simcall_process_get_host(smx_process_t process)
769 return simcall_BODY_process_get_host(process);
773 * \ingroup simix_process_management
774 * \brief Return the name of an agent.
776 * This functions checks whether \a process is a valid pointer or not and return its name.
777 * \param process SIMIX process
778 * \return The process name
780 const char* simcall_process_get_name(smx_process_t process)
782 if (process == SIMIX_process_self()) {
783 /* avoid a simcall if this function is called by the process itself */
784 return process->name;
786 return simcall_BODY_process_get_name(process);
790 * \ingroup simix_process_management
791 * \brief Returns true if the process is suspended .
793 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
794 * \param process SIMIX process
795 * \return 1, if the process is suspended, else 0.
797 int simcall_process_is_suspended(smx_process_t process)
799 return simcall_BODY_process_is_suspended(process);
803 * \ingroup simix_process_management
804 * \brief Return the properties
806 * This functions returns the properties associated with this process
808 xbt_dict_t simcall_process_get_properties(smx_process_t process)
810 return simcall_BODY_process_get_properties(process);
813 * \ingroup simix_process_management
814 * \brief Add an on_exit function
815 * Add an on_exit function which will be executed when the process exits/is killed.
817 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data)
819 simcall_BODY_process_on_exit(process, fun, data);
822 * \ingroup simix_process_management
823 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
824 * Will restart the process when the host comes back up if auto_restart is set to 1.
827 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
829 simcall_BODY_process_auto_restart_set(process, auto_restart);
833 * \ingroup simix_process_management
834 * \brief Restarts the process, killing it and starting it again from scratch.
836 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
838 return simcall_BODY_process_restart(process);
841 * \ingroup simix_process_management
842 * \brief Creates a new sleep SIMIX action.
844 * This function creates a SURF action and allocates the data necessary
845 * to create the SIMIX action. It can raise a host_error exception if the
846 * host crashed. The default SIMIX name of the action is "sleep".
848 * \param duration Time duration of the sleep.
849 * \return A result telling whether the sleep was successful
851 e_smx_state_t simcall_process_sleep(double duration)
853 /* checking for infinite values */
854 xbt_assert(isfinite(duration), "duration is not finite!");
855 return simcall_BODY_process_sleep(duration);
859 * \ingroup simix_rdv_management
860 * \brief Creates a new rendez-vous point
861 * \param name The name of the rendez-vous point
862 * \return The created rendez-vous point
864 smx_rdv_t simcall_rdv_create(const char *name)
866 return simcall_BODY_rdv_create(name);
871 * \ingroup simix_rdv_management
872 * \brief Destroy a rendez-vous point
873 * \param rdv The rendez-vous point to destroy
875 void simcall_rdv_destroy(smx_rdv_t rdv)
877 simcall_BODY_rdv_destroy(rdv);
880 * \ingroup simix_rdv_management
881 * \brief Returns a rendez-vous point knowing its name
883 smx_rdv_t simcall_rdv_get_by_name(const char *name)
885 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
887 /* FIXME: this is a horrible loss of performance, so we hack it out by
888 * skipping the simcall (for now). It works in parallel, it won't work on
889 * distributed but probably we will change MSG for that. */
891 return SIMIX_rdv_get_by_name(name);
895 * \ingroup simix_rdv_management
896 * \brief Counts the number of communication actions of a given host pending
897 * on a rendez-vous point.
898 * \param rdv The rendez-vous point
899 * \param host The host to be counted
900 * \return The number of comm actions pending in the rdv
902 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
904 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
908 * \ingroup simix_rdv_management
909 * \brief returns the communication at the head of the rendez-vous
910 * \param rdv The rendez-vous point
911 * \return The communication or NULL if empty
913 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
915 return simcall_BODY_rdv_get_head(rdv);
918 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
920 simcall_BODY_rdv_set_receiver(rdv, process);
923 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
925 return simcall_BODY_rdv_get_receiver(rdv);
929 * \ingroup simix_comm_management
931 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
932 void *src_buff, size_t src_buff_size,
933 int (*match_fun)(void *, void *, smx_action_t), void *data,
936 /* checking for infinite values */
937 xbt_assert(isfinite(task_size), "task_size is not finite!");
938 xbt_assert(isfinite(rate), "rate is not finite!");
939 xbt_assert(isfinite(timeout), "timeout is not finite!");
941 xbt_assert(rdv, "No rendez-vous point defined for send");
943 if (MC_is_active()) {
944 /* the model-checker wants two separate simcalls */
945 smx_action_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
946 comm = simcall_comm_isend(rdv, task_size, rate,
947 src_buff, src_buff_size, match_fun, NULL, data, 0);
948 simcall_comm_wait(comm, timeout);
952 simcall_BODY_comm_send(rdv, task_size, rate, src_buff, src_buff_size,
953 match_fun, data, timeout);
958 * \ingroup simix_comm_management
960 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
961 void *src_buff, size_t src_buff_size,
962 int (*match_fun)(void *, void *, smx_action_t),
963 void (*clean_fun)(void *),
967 /* checking for infinite values */
968 xbt_assert(isfinite(task_size), "task_size is not finite!");
969 xbt_assert(isfinite(rate), "rate is not finite!");
971 xbt_assert(rdv, "No rendez-vous point defined for isend");
973 return simcall_BODY_comm_isend(rdv, task_size, rate, src_buff,
974 src_buff_size, match_fun,
975 clean_fun, data, detached);
979 * \ingroup simix_comm_management
981 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
982 int (*match_fun)(void *, void *, smx_action_t),
983 void *data, double timeout, double rate)
985 xbt_assert(isfinite(timeout), "timeout is not finite!");
986 xbt_assert(rdv, "No rendez-vous point defined for recv");
988 if (MC_is_active()) {
989 /* the model-checker wants two separate simcalls */
990 smx_action_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
991 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
992 match_fun, data, rate);
993 simcall_comm_wait(comm, timeout);
997 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
998 match_fun, data, timeout, rate);
1002 * \ingroup simix_comm_management
1004 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1005 int (*match_fun)(void *, void *, smx_action_t),
1006 void *data, double rate)
1008 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1010 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1011 match_fun, data, rate);
1015 * \ingroup simix_comm_management
1017 smx_action_t simcall_comm_iprobe(smx_rdv_t rdv, int src, int tag,
1018 int (*match_fun)(void *, void *, smx_action_t), void *data)
1020 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1022 return simcall_BODY_comm_iprobe(rdv, src, tag, match_fun, data);
1026 * \ingroup simix_comm_management
1028 void simcall_comm_cancel(smx_action_t comm)
1030 simcall_BODY_comm_cancel(comm);
1034 * \ingroup simix_comm_management
1036 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1038 return simcall_BODY_comm_waitany(comms);
1042 * \ingroup simix_comm_management
1044 int simcall_comm_testany(xbt_dynar_t comms)
1046 if (xbt_dynar_is_empty(comms))
1048 return simcall_BODY_comm_testany(comms);
1052 * \ingroup simix_comm_management
1054 void simcall_comm_wait(smx_action_t comm, double timeout)
1056 xbt_assert(isfinite(timeout), "timeout is not finite!");
1057 simcall_BODY_comm_wait(comm, timeout);
1062 * \brief Set the category of an action.
1064 * This functions changes the category only. It calls a surf function.
1065 * \param execution The execution action
1066 * \param category The tracing category
1068 void simcall_set_category(smx_action_t action, const char *category)
1070 if (category == NULL) {
1073 simcall_BODY_set_category(action, category);
1078 * \ingroup simix_comm_management
1081 int simcall_comm_test(smx_action_t comm)
1083 return simcall_BODY_comm_test(comm);
1087 * \ingroup simix_comm_management
1090 double simcall_comm_get_remains(smx_action_t comm)
1092 return simcall_BODY_comm_get_remains(comm);
1096 * \ingroup simix_comm_management
1099 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
1101 return simcall_BODY_comm_get_state(comm);
1105 * \ingroup simix_comm_management
1108 void *simcall_comm_get_src_data(smx_action_t comm)
1110 return simcall_BODY_comm_get_src_data(comm);
1114 * \ingroup simix_comm_management
1117 void *simcall_comm_get_dst_data(smx_action_t comm)
1119 return simcall_BODY_comm_get_dst_data(comm);
1123 * \ingroup simix_comm_management
1126 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
1128 return simcall_BODY_comm_get_src_proc(comm);
1132 * \ingroup simix_comm_management
1135 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
1137 return simcall_BODY_comm_get_dst_proc(comm);
1140 #ifdef HAVE_LATENCY_BOUND_TRACKING
1141 int simcall_comm_is_latency_bounded(smx_action_t comm)
1143 return simcall_BODY_comm_is_latency_bounded(comm);
1148 * \ingroup simix_synchro_management
1151 smx_mutex_t simcall_mutex_init(void)
1154 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
1157 return simcall_BODY_mutex_init();
1161 * \ingroup simix_synchro_management
1164 void simcall_mutex_destroy(smx_mutex_t mutex)
1166 simcall_BODY_mutex_destroy(mutex);
1170 * \ingroup simix_synchro_management
1173 void simcall_mutex_lock(smx_mutex_t mutex)
1175 simcall_BODY_mutex_lock(mutex);
1179 * \ingroup simix_synchro_management
1182 int simcall_mutex_trylock(smx_mutex_t mutex)
1184 return simcall_BODY_mutex_trylock(mutex);
1188 * \ingroup simix_synchro_management
1191 void simcall_mutex_unlock(smx_mutex_t mutex)
1193 simcall_BODY_mutex_unlock(mutex);
1197 * \ingroup simix_synchro_management
1200 smx_cond_t simcall_cond_init(void)
1202 return simcall_BODY_cond_init();
1206 * \ingroup simix_synchro_management
1209 void simcall_cond_destroy(smx_cond_t cond)
1211 simcall_BODY_cond_destroy(cond);
1215 * \ingroup simix_synchro_management
1218 void simcall_cond_signal(smx_cond_t cond)
1220 simcall_BODY_cond_signal(cond);
1224 * \ingroup simix_synchro_management
1227 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1229 simcall_BODY_cond_wait(cond, mutex);
1233 * \ingroup simix_synchro_management
1236 void simcall_cond_wait_timeout(smx_cond_t cond,
1240 xbt_assert(isfinite(timeout), "timeout is not finite!");
1241 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1245 * \ingroup simix_synchro_management
1248 void simcall_cond_broadcast(smx_cond_t cond)
1250 simcall_BODY_cond_broadcast(cond);
1254 * \ingroup simix_synchro_management
1257 smx_sem_t simcall_sem_init(int capacity)
1259 return simcall_BODY_sem_init(capacity);
1263 * \ingroup simix_synchro_management
1266 void simcall_sem_destroy(smx_sem_t sem)
1268 simcall_BODY_sem_destroy(sem);
1272 * \ingroup simix_synchro_management
1275 void simcall_sem_release(smx_sem_t sem)
1277 simcall_BODY_sem_release(sem);
1281 * \ingroup simix_synchro_management
1284 int simcall_sem_would_block(smx_sem_t sem)
1286 return simcall_BODY_sem_would_block(sem);
1290 * \ingroup simix_synchro_management
1293 void simcall_sem_acquire(smx_sem_t sem)
1295 simcall_BODY_sem_acquire(sem);
1299 * \ingroup simix_synchro_management
1302 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1304 xbt_assert(isfinite(timeout), "timeout is not finite!");
1305 simcall_BODY_sem_acquire_timeout(sem, timeout);
1309 * \ingroup simix_synchro_management
1312 int simcall_sem_get_capacity(smx_sem_t sem)
1314 return simcall_BODY_sem_get_capacity(sem);
1318 * \ingroup simix_file_management
1321 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, smx_host_t host)
1323 return simcall_BODY_file_read(fd, size, host);
1327 * \ingroup simix_file_management
1330 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, smx_host_t host)
1332 return simcall_BODY_file_write(fd, size, host);
1336 * \ingroup simix_file_management
1339 smx_file_t simcall_file_open(const char* fullpath, smx_host_t host)
1341 return simcall_BODY_file_open(fullpath, host);
1345 * \ingroup simix_file_management
1348 int simcall_file_close(smx_file_t fd, smx_host_t host)
1350 return simcall_BODY_file_close(fd, host);
1354 * \ingroup simix_file_management
1357 int simcall_file_unlink(smx_file_t fd)
1359 return simcall_BODY_file_unlink(fd);
1363 * \ingroup simix_file_management
1366 sg_size_t simcall_file_get_size(smx_file_t fd){
1367 return simcall_BODY_file_get_size(fd);
1371 * \ingroup simix_file_management
1374 sg_size_t simcall_file_tell(smx_file_t fd){
1375 return simcall_BODY_file_tell(fd);
1379 * \ingroup simix_file_management
1382 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1384 return simcall_BODY_file_get_info(fd);
1388 * \ingroup simix_file_management
1391 int simcall_file_seek(smx_file_t fd, sg_size_t offset, int origin){
1392 return simcall_BODY_file_seek(fd, offset, origin);
1396 * \ingroup simix_file_management
1397 * \brief Move a file to another location on the *same mount point*.
1400 int simcall_file_move(smx_file_t fd, const char* fullpath)
1402 return simcall_BODY_file_move(fd, fullpath);
1406 * \ingroup simix_storage_management
1407 * \brief Returns the free space size on a given storage element.
1408 * \param storage name
1409 * \return Return the free space size on a given storage element (as sg_size_t)
1411 sg_size_t simcall_storage_get_free_size (const char* name){
1412 return simcall_BODY_storage_get_free_size(name);
1416 * \ingroup simix_storage_management
1417 * \brief Returns the used space size on a given storage element.
1418 * \param storage name
1419 * \return Return the used space size on a given storage element (as sg_size_t)
1421 sg_size_t simcall_storage_get_used_size (const char* name){
1422 return simcall_BODY_storage_get_used_size(name);
1426 * \ingroup simix_storage_management
1427 * \brief Returns the list of storages mounted on an host.
1428 * \param host A SIMIX host
1429 * \return a dict containing all storages mounted on the host
1431 xbt_dict_t simcall_host_get_mounted_storage_list(smx_host_t host)
1433 return simcall_BODY_host_get_mounted_storage_list(host);
1437 * \ingroup simix_storage_management
1438 * \brief Returns the list of storages attached to an host.
1439 * \param host A SIMIX host
1440 * \return a dict containing all storages attached to the host
1442 xbt_dynar_t simcall_host_get_attached_storage_list(smx_host_t host)
1444 return simcall_BODY_host_get_attached_storage_list(host);
1448 * \ingroup simix_storage_management
1449 * \brief Returns a dict of the properties assigned to a storage element.
1451 * \param storage A storage element
1452 * \return The properties of this storage element
1454 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1456 return simcall_BODY_storage_get_properties(storage);
1460 * \ingroup simix_storage_management
1461 * \brief Returns a dict containing the content of a storage element.
1463 * \param storage A storage element
1464 * \return The content of this storage element as a dict (full path file => size)
1466 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1468 return simcall_BODY_storage_get_content(storage);
1473 void *simcall_mc_snapshot(void)
1475 return simcall_BODY_mc_snapshot();
1478 int simcall_mc_compare_snapshots(void *s1, void *s2){
1479 return simcall_BODY_mc_compare_snapshots(s1, s2);
1482 int simcall_mc_random(int min, int max)
1484 return simcall_BODY_mc_random(min, max);
1488 #endif /* HAVE_MC */
1490 /* ****************************************************************************************** */
1491 /* TUTORIAL: New API */
1492 /* All functions for simcall */
1493 /* ****************************************************************************************** */
1494 int simcall_new_api_fct(const char* param1, double param2){
1495 smx_simcall_t simcall = SIMIX_simcall_mine();
1496 simcall->call = SIMCALL_NEW_API_INIT;
1497 simcall->new_api.param1 = param1;
1498 simcall->new_api.param2 = param2;
1500 SIMIX_simcall_push(simcall->issuer);
1501 return simcall->new_api.result;
1504 /* ************************************************************************** */
1506 /** @brief returns a printable string representing a simcall */
1507 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1508 return simcall_names[kind];