1 /* smx_user.c - public interface to simix */
3 /* Copyright (c) 2010-2013. 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 SIMCALL_LIST(SIMCALL_STRING_TYPE, SIMCALL_SEP_COMMA)
19 [SIMCALL_NONE] = "NONE"
22 SIMCALL_LIST(SIMCALL_FUNC, SIMCALL_SEP_NOTHING)
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 user data associated to a host.
161 * \param host SIMIX host
162 * \return the user data of this host
164 void* simcall_host_get_data(smx_host_t host)
166 return simcall_BODY_host_get_data(host);
170 * \ingroup simix_host_management
171 * \brief Sets the user data associated to a host.
173 * The host must not have previous user data associated to it.
174 * \param host A SIMIX host
175 * \param data The user data to set
177 void simcall_host_set_data(smx_host_t host, void *data)
179 simcall_host_set_data(host, data);
183 * \ingroup simix_host_management
184 * \brief Returns the power peak of a host.
186 * \param host A SIMIX host
187 * \return the current power peak value (double)
189 double simcall_host_get_current_power_peak(smx_host_t host)
191 return simcall_BODY_host_get_current_power_peak(host);
195 * \ingroup simix_host_management
196 * \brief Returns one power peak (in flops/s) of a host at a given pstate
198 * \param host A SIMIX host
199 * \param pstate_index pstate to test
200 * \return the current power peak value (double) for pstate_index
202 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
204 return simcall_BODY_host_get_power_peak_at(host, pstate_index);
208 * \ingroup simix_host_management
209 * \brief Returns the number of power states for a host.
211 * \param host A SIMIX host
212 * \return the number of power states
214 int simcall_host_get_nb_pstates(smx_host_t host)
216 return simcall_BODY_host_get_nb_pstates(host);
220 * \ingroup simix_host_management
221 * \brief Sets a new power peak for a host.
223 * \param host A SIMIX host
224 * \param pstate_index The pstate to which the CPU power will be set
227 void simcall_host_set_power_peak_at(smx_host_t host, int pstate_index)
229 simcall_BODY_host_set_power_peak_at(host, pstate_index);
233 * \ingroup simix_host_management
234 * \brief Returns the total energy consumed by the host (in Joules)
236 * \param host A SIMIX host
237 * \return the energy consumed by the host (double)
239 double simcall_host_get_consumed_energy(smx_host_t host)
241 return simcall_BODY_host_get_consumed_energy(host);
246 * \ingroup simix_host_management
247 * \brief Creates an action that executes some computation of an host.
249 * This function creates a SURF action and allocates the data necessary
250 * to create the SIMIX action. It can raise a host_error exception if the host crashed.
252 * \param name Name of the execution action to create
253 * \param host SIMIX host where the action will be executed
254 * \param computation_amount amount Computation amount (in bytes)
255 * \param priority computation priority
257 * \param affinity_mask
258 * \return A new SIMIX execution action
260 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
261 double computation_amount,
262 double priority, double bound, unsigned long affinity_mask)
264 /* checking for infinite values */
265 xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
266 xbt_assert(isfinite(priority), "priority is not finite!");
268 return simcall_BODY_host_execute(name, host, computation_amount, priority, bound, affinity_mask);
272 * \ingroup simix_host_management
273 * \brief Creates an action that may involve parallel computation on
274 * several hosts and communication between them.
276 * \param name Name of the execution action to create
277 * \param host_nb Number of hosts where the action will be executed
278 * \param host_list Array (of size host_nb) of hosts where the action will be executed
279 * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
280 * \param communication_amount Array (of size host_nb * host_nb) representing the communication
281 * amount between each pair of hosts
282 * \param amount the SURF action amount
283 * \param rate the SURF action rate
284 * \return A new SIMIX execution action
286 smx_action_t simcall_host_parallel_execute(const char *name,
288 smx_host_t *host_list,
289 double *computation_amount,
290 double *communication_amount,
295 /* checking for infinite values */
296 for (i = 0 ; i < host_nb ; ++i) {
297 xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
298 for (j = 0 ; j < host_nb ; ++j) {
299 xbt_assert(isfinite(communication_amount[i + host_nb * j]),
300 "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
304 xbt_assert(isfinite(amount), "amount is not finite!");
305 xbt_assert(isfinite(rate), "rate is not finite!");
307 return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
309 communication_amount,
315 * \ingroup simix_host_management
316 * \brief Destroys an execution action.
318 * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
319 * \param execution The execution action to destroy
321 void simcall_host_execution_destroy(smx_action_t execution)
323 simcall_BODY_host_execution_destroy(execution);
327 * \ingroup simix_host_management
328 * \brief Cancels an execution action.
330 * This functions stops the execution. It calls a surf function.
331 * \param execution The execution action to cancel
333 void simcall_host_execution_cancel(smx_action_t execution)
335 simcall_BODY_host_execution_cancel(execution);
339 * \ingroup simix_host_management
340 * \brief Returns how much of an execution action remains to be done.
342 * \param execution The execution action
343 * \return The remaining amount
345 double simcall_host_execution_get_remains(smx_action_t execution)
347 return simcall_BODY_host_execution_get_remains(execution);
351 * \ingroup simix_host_management
352 * \brief Returns the state of an execution action.
354 * \param execution The execution action
357 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
359 return simcall_BODY_host_execution_get_state(execution);
363 * \ingroup simix_host_management
364 * \brief Changes the priority of an execution action.
366 * This functions changes the priority only. It calls a surf function.
367 * \param execution The execution action
368 * \param priority The new priority
370 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
372 /* checking for infinite values */
373 xbt_assert(isfinite(priority), "priority is not finite!");
375 simcall_BODY_host_execution_set_priority(execution, priority);
379 * \ingroup simix_host_management
380 * \brief Changes the capping (the maximum CPU utilization) of an execution action.
382 * This functions changes the capping only. It calls a surf function.
383 * \param execution The execution action
384 * \param bound The new bound
386 void simcall_host_execution_set_bound(smx_action_t execution, double bound)
388 simcall_BODY_host_execution_set_bound(execution, bound);
392 * \ingroup simix_host_management
393 * \brief Changes the CPU affinity of an execution action.
395 * This functions changes the CPU affinity of an execution action. See taskset(1) on Linux.
396 * \param execution The execution action
398 * \param mask Affinity mask
400 void simcall_host_execution_set_affinity(smx_action_t execution, smx_host_t host, unsigned long mask)
402 simcall_BODY_host_execution_set_affinity(execution, host, mask);
406 * \ingroup simix_host_management
407 * \brief Waits for the completion of an execution action and destroy it.
409 * \param execution The execution action
411 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
413 return simcall_BODY_host_execution_wait(execution);
418 * \ingroup simix_vm_management
419 * \brief Create a VM on the given physical host.
421 * \param name VM name
422 * \param host Physical host
424 * \return The host object of the VM
426 void* simcall_vm_create(const char *name, smx_host_t phys_host){
427 /* will jump to SIMIX_pre_vm_create() in src/simix/smx_smurf_private.h */
428 return simcall_BODY_vm_create(name, phys_host);
432 * \ingroup simix_vm_management
433 * \brief Start the given VM to the given physical host
437 void simcall_vm_start(smx_host_t vm)
439 /* will jump to SIMIX_pre_vm_start in src/simix/smx_smurf_private.h */
440 simcall_BODY_vm_start(vm);
444 * \ingroup simix_vm_management
445 * \brief Get the state of the given VM
448 * \return The state of the VM
450 int simcall_vm_get_state(smx_host_t vm)
452 /* will jump to SIMIX_pre_vm_get_state in src/simix/smx_smurf_private.h */
453 return simcall_BODY_vm_get_state(vm);
457 * \ingroup simix_vm_management
458 * \brief Get the name of the physical host on which the given VM runs.
461 * \return The name of the physical host
463 void *simcall_vm_get_pm(smx_host_t vm)
465 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
466 return simcall_BODY_vm_get_pm(vm);
469 void simcall_vm_set_bound(smx_host_t vm, double bound)
471 /* will jump to SIMIX_pre_vm_set_bound in src/simix/smx_smurf_private.h */
472 simcall_BODY_vm_set_bound(vm, bound);
475 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
477 /* will jump to SIMIX_pre_vm_set_affinity in src/simix/smx_smurf_private.h */
478 simcall_BODY_vm_set_affinity(vm, pm, mask);
481 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
483 /* will jump to SIMIX_pre_host_get_params in src/simix/smx_smurf_private.h */
484 simcall_BODY_host_get_params(vm, params);
487 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
489 /* will jump to SIMIX_pre_host_set_params in src/simix/smx_smurf_private.h */
490 simcall_BODY_host_set_params(vm, params);
494 * \ingroup simix_vm_management
495 * \brief Migrate the given VM to the given physical host
498 * \param host Destination physical host
500 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
502 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
503 simcall_BODY_vm_migrate(vm, host);
507 * \ingroup simix_vm_management
508 * \brief Suspend the given VM
512 void simcall_vm_suspend(smx_host_t vm)
514 /* will jump to SIMIX_pre_vm_suspend in src/simix/smx_smurf_private.h */
515 simcall_BODY_vm_suspend(vm);
519 * \ingroup simix_vm_management
520 * \brief Resume the given VM
524 void simcall_vm_resume(smx_host_t vm)
526 /* will jump to SIMIX_pre_vm_resume in src/simix/smx_smurf_private.h */
527 simcall_BODY_vm_resume(vm);
531 * \ingroup simix_vm_management
532 * \brief Save the given VM
536 void simcall_vm_save(smx_host_t vm)
538 /* will jump to SIMIX_pre_vm_save in src/simix/smx_smurf_private.h */
539 simcall_BODY_vm_save(vm);
543 * \ingroup simix_vm_management
544 * \brief Restore the given VM
548 void simcall_vm_restore(smx_host_t vm)
550 /* will jump to SIMIX_pre_vm_restore in src/simix/smx_smurf_private.h */
551 simcall_BODY_vm_restore(vm);
555 * \ingroup simix_vm_management
556 * \brief Shutdown the given VM
560 void simcall_vm_shutdown(smx_host_t vm)
562 /* will jump to SIMIX_pre_vm_shutdown in src/simix/smx_smurf_private.h */
563 simcall_BODY_vm_shutdown(vm);
567 * \ingroup simix_vm_management
568 * \brief Destroy the given VM
572 void simcall_vm_destroy(smx_host_t vm)
574 /* will jump to SIMIX_pre_vm_destroy in src/simix/smx_smurf_private.h */
575 simcall_BODY_vm_destroy(vm);
580 * \ingroup simix_process_management
581 * \brief Creates and runs a new SIMIX process.
583 * The structure and the corresponding thread are created and put in the list of ready processes.
585 * \param process the process created will be stored in this pointer
586 * \param name a name for the process. It is for user-level information and can be NULL.
587 * \param code the main function of the process
588 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can be NULL.
589 * It can be retrieved with the function \ref simcall_process_get_data.
590 * \param hostname name of the host where the new agent is executed.
591 * \param kill_time time when the process is killed
592 * \param argc first argument passed to \a code
593 * \param argv second argument passed to \a code
594 * \param properties the properties of the process
595 * \param auto_restart either it is autorestarting or not.
597 void simcall_process_create(smx_process_t *process, const char *name,
598 xbt_main_func_t code,
600 const char *hostname,
602 int argc, char **argv,
603 xbt_dict_t properties,
606 simcall_BODY_process_create(process, name, code, data, hostname,
607 kill_time, argc, argv, properties,
612 * \ingroup simix_process_management
613 * \brief Kills a SIMIX process.
615 * This function simply kills a process.
617 * \param process poor victim
619 void simcall_process_kill(smx_process_t process)
621 simcall_BODY_process_kill(process);
625 * \ingroup simix_process_management
626 * \brief Kills all SIMIX processes.
628 void simcall_process_killall(int reset_pid)
630 simcall_BODY_process_killall(reset_pid);
634 * \ingroup simix_process_management
635 * \brief Cleans up a SIMIX process.
636 * \param process poor victim (must have already been killed)
638 void simcall_process_cleanup(smx_process_t process)
640 simcall_BODY_process_cleanup(process);
644 * \ingroup simix_process_management
645 * \brief Migrates an agent to another location.
647 * This function changes the value of the host on which \a process is running.
649 * \param process the process to migrate
650 * \param dest name of the new host
652 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
654 simcall_BODY_process_change_host(process, dest);
658 * \ingroup simix_process_management
659 * \brief Suspends a process.
661 * This function suspends the process by suspending the action
662 * it was waiting for completion.
664 * \param process a SIMIX process
666 void simcall_process_suspend(smx_process_t process)
668 xbt_assert(process, "Invalid parameters");
670 simcall_BODY_process_suspend(process);
674 * \ingroup simix_process_management
675 * \brief Resumes a suspended process.
677 * This function resumes a suspended process by resuming the action
678 * it was waiting for completion.
680 * \param process a SIMIX process
682 void simcall_process_resume(smx_process_t process)
684 simcall_BODY_process_resume(process);
688 * \ingroup simix_process_management
689 * \brief Returns the amount of SIMIX processes in the system
691 * Maestro internal process is not counted, only user code processes are
693 int simcall_process_count(void)
695 return simcall_BODY_process_count();
699 * \ingroup simix_process_management
700 * \brief Return the PID of a #smx_process_t.
701 * \param process a SIMIX process
702 * \return the PID of this process
704 int simcall_process_get_PID(smx_process_t process)
706 if (process == SIMIX_process_self()) {
707 /* avoid a simcall if this function is called by the process itself */
708 return SIMIX_process_get_PID(process);
711 return simcall_BODY_process_get_PID(process);
715 * \ingroup simix_process_management
716 * \brief Return the parent PID of a #smx_process_t.
717 * \param process a SIMIX process
718 * \return the PID of this process parenrt
720 int simcall_process_get_PPID(smx_process_t process)
722 if (process == SIMIX_process_self()) {
723 /* avoid a simcall if this function is called by the process itself */
724 return SIMIX_process_get_PPID(process);
727 return simcall_BODY_process_get_PPID(process);
731 * \ingroup simix_process_management
732 * \brief Return the user data of a #smx_process_t.
733 * \param process a SIMIX process
734 * \return the user data of this process
736 void* simcall_process_get_data(smx_process_t process)
738 if (process == SIMIX_process_self()) {
739 /* avoid a simcall if this function is called by the process itself */
740 return SIMIX_process_get_data(process);
743 return simcall_BODY_process_get_data(process);
747 * \ingroup simix_process_management
748 * \brief Set the user data of a #smx_process_t.
750 * This functions sets the user data associated to \a process.
751 * \param process SIMIX process
752 * \param data User data
754 void simcall_process_set_data(smx_process_t process, void *data)
756 if (process == SIMIX_process_self()) {
757 /* avoid a simcall if this function is called by the process itself */
758 SIMIX_process_self_set_data(process, data);
761 simcall_BODY_process_set_data(process, data);
766 * \ingroup simix_process_management
767 * \brief Set the kill time of a process.
768 * \param process a process
769 * \param kill_time a double
771 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
774 if (kill_time > SIMIX_get_clock()) {
775 if (simix_global->kill_process_function) {
776 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
777 sg_host_name(process->smx_host));
778 SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
784 * \ingroup simix_process_management
785 * \brief Return the location on which an agent is running.
787 * This functions returns the smx_host_t corresponding to the location on which
788 * \a process is running.
789 * \param process SIMIX process
792 smx_host_t simcall_process_get_host(smx_process_t process)
794 return simcall_BODY_process_get_host(process);
798 * \ingroup simix_process_management
799 * \brief Return the name of an agent.
801 * This functions checks whether \a process is a valid pointer or not and return its name.
802 * \param process SIMIX process
803 * \return The process name
805 const char* simcall_process_get_name(smx_process_t process)
807 if (process == SIMIX_process_self()) {
808 /* avoid a simcall if this function is called by the process itself */
809 return process->name;
811 return simcall_BODY_process_get_name(process);
815 * \ingroup simix_process_management
816 * \brief Returns true if the process is suspended .
818 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
819 * \param process SIMIX process
820 * \return 1, if the process is suspended, else 0.
822 int simcall_process_is_suspended(smx_process_t process)
824 return simcall_BODY_process_is_suspended(process);
828 * \ingroup simix_process_management
829 * \brief Return the properties
831 * This functions returns the properties associated with this process
833 xbt_dict_t simcall_process_get_properties(smx_process_t process)
835 return simcall_BODY_process_get_properties(process);
838 * \ingroup simix_process_management
839 * \brief Add an on_exit function
840 * Add an on_exit function which will be executed when the process exits/is killed.
842 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data)
844 simcall_BODY_process_on_exit(process, fun, data);
847 * \ingroup simix_process_management
848 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
849 * Will restart the process when the host comes back up if auto_restart is set to 1.
852 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
854 simcall_BODY_process_auto_restart_set(process, auto_restart);
858 * \ingroup simix_process_management
859 * \brief Restarts the process, killing it and starting it again from scratch.
861 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
863 return simcall_BODY_process_restart(process);
866 * \ingroup simix_process_management
867 * \brief Creates a new sleep SIMIX action.
869 * This function creates a SURF action and allocates the data necessary
870 * to create the SIMIX action. It can raise a host_error exception if the
871 * host crashed. The default SIMIX name of the action is "sleep".
873 * \param duration Time duration of the sleep.
874 * \return A result telling whether the sleep was successful
876 e_smx_state_t simcall_process_sleep(double duration)
878 /* checking for infinite values */
879 xbt_assert(isfinite(duration), "duration is not finite!");
880 return simcall_BODY_process_sleep(duration);
884 * \ingroup simix_rdv_management
885 * \brief Creates a new rendez-vous point
886 * \param name The name of the rendez-vous point
887 * \return The created rendez-vous point
889 smx_rdv_t simcall_rdv_create(const char *name)
891 return simcall_BODY_rdv_create(name);
896 * \ingroup simix_rdv_management
897 * \brief Destroy a rendez-vous point
898 * \param rdv The rendez-vous point to destroy
900 void simcall_rdv_destroy(smx_rdv_t rdv)
902 simcall_BODY_rdv_destroy(rdv);
905 * \ingroup simix_rdv_management
906 * \brief Returns a rendez-vous point knowing its name
908 smx_rdv_t simcall_rdv_get_by_name(const char *name)
910 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
912 /* FIXME: this is a horrible loss of performance, so we hack it out by
913 * skipping the simcall (for now). It works in parallel, it won't work on
914 * distributed but probably we will change MSG for that. */
917 smx_simcall_t simcall = simcall_mine();
918 simcall->call = SIMCALL_RDV_GEY_BY_NAME;
919 simcall->rdv_get_by_name.name = name;
920 SIMIX_simcall_push(simcall->issuer);
921 return simcall->rdv_get_by_name.result;*/
923 return SIMIX_rdv_get_by_name(name);
927 * \ingroup simix_rdv_management
928 * \brief Counts the number of communication actions of a given host pending
929 * on a rendez-vous point.
930 * \param rdv The rendez-vous point
931 * \param host The host to be counted
932 * \return The number of comm actions pending in the rdv
934 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
936 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
940 * \ingroup simix_rdv_management
941 * \brief returns the communication at the head of the rendez-vous
942 * \param rdv The rendez-vous point
943 * \return The communication or NULL if empty
945 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
947 return simcall_BODY_rdv_get_head(rdv);
950 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
952 simcall_BODY_rdv_set_receiver(rdv, process);
955 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
957 return simcall_BODY_rdv_get_receiver(rdv);
961 * \ingroup simix_comm_management
963 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
964 void *src_buff, size_t src_buff_size,
965 int (*match_fun)(void *, void *, smx_action_t), void *data,
968 /* checking for infinite values */
969 xbt_assert(isfinite(task_size), "task_size is not finite!");
970 xbt_assert(isfinite(rate), "rate is not finite!");
971 xbt_assert(isfinite(timeout), "timeout is not finite!");
973 xbt_assert(rdv, "No rendez-vous point defined for send");
975 if (MC_is_active()) {
976 /* the model-checker wants two separate simcalls */
977 smx_action_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
978 comm = simcall_comm_isend(rdv, task_size, rate,
979 src_buff, src_buff_size, match_fun, NULL, data, 0);
980 simcall_comm_wait(comm, timeout);
984 simcall_BODY_comm_send(rdv, task_size, rate, src_buff, src_buff_size,
985 match_fun, data, timeout);
990 * \ingroup simix_comm_management
992 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
993 void *src_buff, size_t src_buff_size,
994 int (*match_fun)(void *, void *, smx_action_t),
995 void (*clean_fun)(void *),
999 /* checking for infinite values */
1000 xbt_assert(isfinite(task_size), "task_size is not finite!");
1001 xbt_assert(isfinite(rate), "rate is not finite!");
1003 xbt_assert(rdv, "No rendez-vous point defined for isend");
1005 return simcall_BODY_comm_isend(rdv, task_size, rate, src_buff,
1006 src_buff_size, match_fun,
1007 clean_fun, data, detached);
1010 * \ingroup simix_comm_management
1012 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
1013 int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
1015 xbt_assert(isfinite(timeout), "timeout is not finite!");
1016 xbt_assert(rdv, "No rendez-vous point defined for recv");
1018 if (MC_is_active()) {
1019 /* the model-checker wants two separate simcalls */
1020 smx_action_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
1021 comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
1023 simcall_comm_wait(comm, timeout);
1027 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
1028 match_fun, data, timeout);
1032 * \ingroup simix_comm_management
1034 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1035 int (*match_fun)(void *, void *, smx_action_t), void *data)
1037 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1039 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1045 * \ingroup simix_comm_management
1047 void simcall_comm_recv_bounded(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
1048 int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout, double rate)
1050 xbt_assert(isfinite(timeout), "timeout is not finite!");
1051 xbt_assert(rdv, "No rendez-vous point defined for recv");
1053 if (MC_is_active()) {
1054 /* the model-checker wants two separate simcalls */
1055 smx_action_t comm = simcall_comm_irecv_bounded(rdv, dst_buff, dst_buff_size,
1056 match_fun, data, rate);
1057 simcall_comm_wait(comm, timeout);
1060 simcall_BODY_comm_recv_bounded(rdv, dst_buff, dst_buff_size,
1061 match_fun, data, timeout, rate);
1065 * \ingroup simix_comm_management
1067 smx_action_t simcall_comm_irecv_bounded(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
1068 int (*match_fun)(void *, void *, smx_action_t), void *data, double rate)
1070 xbt_assert(rdv, "No rendez-vous point defined for irecv");
1072 return simcall_BODY_comm_irecv_bounded(rdv, dst_buff, dst_buff_size,
1073 match_fun, data, rate);
1078 * \ingroup simix_comm_management
1080 smx_action_t simcall_comm_iprobe(smx_rdv_t rdv, int src, int tag,
1081 int (*match_fun)(void *, void *, smx_action_t), void *data)
1083 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1085 return simcall_BODY_comm_iprobe(rdv, src, tag, match_fun, data);
1088 void simcall_comm_destroy(smx_action_t comm)
1090 xbt_assert(comm, "Invalid parameter");
1092 /* FIXME remove this simcall type: comms are auto-destroyed now */
1095 smx_simcall_t simcall = simcall_mine();
1097 simcall->call = SIMCALL_COMM_DESTROY;
1098 simcall->comm_destroy.comm = comm;
1100 SIMIX_simcall_push(simcall->issuer);
1105 * \ingroup simix_comm_management
1107 void simcall_comm_cancel(smx_action_t comm)
1109 simcall_BODY_comm_cancel(comm);
1113 * \ingroup simix_comm_management
1115 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1117 return simcall_BODY_comm_waitany(comms);
1121 * \ingroup simix_comm_management
1123 int simcall_comm_testany(xbt_dynar_t comms)
1125 if (xbt_dynar_is_empty(comms))
1127 return simcall_BODY_comm_testany(comms);
1131 * \ingroup simix_comm_management
1133 void simcall_comm_wait(smx_action_t comm, double timeout)
1135 xbt_assert(isfinite(timeout), "timeout is not finite!");
1136 simcall_BODY_comm_wait(comm, timeout);
1141 * \brief Set the category of an action.
1143 * This functions changes the category only. It calls a surf function.
1144 * \param execution The execution action
1145 * \param category The tracing category
1147 void simcall_set_category(smx_action_t action, const char *category)
1149 if (category == NULL) {
1152 simcall_BODY_set_category(action, category);
1157 * \ingroup simix_comm_management
1160 int simcall_comm_test(smx_action_t comm)
1162 return simcall_BODY_comm_test(comm);
1166 * \ingroup simix_comm_management
1169 double simcall_comm_get_remains(smx_action_t comm)
1171 return simcall_BODY_comm_get_remains(comm);
1175 * \ingroup simix_comm_management
1178 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
1180 return simcall_BODY_comm_get_state(comm);
1184 * \ingroup simix_comm_management
1187 void *simcall_comm_get_src_data(smx_action_t comm)
1189 return simcall_BODY_comm_get_src_data(comm);
1193 * \ingroup simix_comm_management
1196 void *simcall_comm_get_dst_data(smx_action_t comm)
1198 return simcall_BODY_comm_get_dst_data(comm);
1202 * \ingroup simix_comm_management
1205 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
1207 return simcall_BODY_comm_get_src_proc(comm);
1211 * \ingroup simix_comm_management
1214 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
1216 return simcall_BODY_comm_get_dst_proc(comm);
1219 #ifdef HAVE_LATENCY_BOUND_TRACKING
1220 int simcall_comm_is_latency_bounded(smx_action_t comm)
1222 return simcall_BODY_comm_is_latency_bounded(comm);
1227 * \ingroup simix_synchro_management
1230 smx_mutex_t simcall_mutex_init(void)
1233 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
1236 return simcall_BODY_mutex_init();
1240 * \ingroup simix_synchro_management
1243 void simcall_mutex_destroy(smx_mutex_t mutex)
1245 simcall_BODY_mutex_destroy(mutex);
1249 * \ingroup simix_synchro_management
1252 void simcall_mutex_lock(smx_mutex_t mutex)
1254 simcall_BODY_mutex_lock(mutex);
1258 * \ingroup simix_synchro_management
1261 int simcall_mutex_trylock(smx_mutex_t mutex)
1263 return simcall_BODY_mutex_trylock(mutex);
1267 * \ingroup simix_synchro_management
1270 void simcall_mutex_unlock(smx_mutex_t mutex)
1272 simcall_BODY_mutex_unlock(mutex);
1276 * \ingroup simix_synchro_management
1279 smx_cond_t simcall_cond_init(void)
1281 return simcall_BODY_cond_init();
1285 * \ingroup simix_synchro_management
1288 void simcall_cond_destroy(smx_cond_t cond)
1290 simcall_BODY_cond_destroy(cond);
1294 * \ingroup simix_synchro_management
1297 void simcall_cond_signal(smx_cond_t cond)
1299 simcall_BODY_cond_signal(cond);
1303 * \ingroup simix_synchro_management
1306 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1308 simcall_BODY_cond_wait(cond, mutex);
1312 * \ingroup simix_synchro_management
1315 void simcall_cond_wait_timeout(smx_cond_t cond,
1319 xbt_assert(isfinite(timeout), "timeout is not finite!");
1320 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1324 * \ingroup simix_synchro_management
1327 void simcall_cond_broadcast(smx_cond_t cond)
1329 simcall_BODY_cond_broadcast(cond);
1333 * \ingroup simix_synchro_management
1336 smx_sem_t simcall_sem_init(int capacity)
1338 return simcall_BODY_sem_init(capacity);
1342 * \ingroup simix_synchro_management
1345 void simcall_sem_destroy(smx_sem_t sem)
1347 simcall_sem_destroy(sem);
1351 * \ingroup simix_synchro_management
1354 void simcall_sem_release(smx_sem_t sem)
1356 simcall_BODY_sem_release(sem);
1360 * \ingroup simix_synchro_management
1363 int simcall_sem_would_block(smx_sem_t sem)
1365 return simcall_BODY_sem_would_block(sem);
1369 * \ingroup simix_synchro_management
1372 void simcall_sem_acquire(smx_sem_t sem)
1374 simcall_BODY_sem_acquire(sem);
1378 * \ingroup simix_synchro_management
1381 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1383 xbt_assert(isfinite(timeout), "timeout is not finite!");
1384 simcall_BODY_sem_acquire_timeout(sem, timeout);
1388 * \ingroup simix_synchro_management
1391 int simcall_sem_get_capacity(smx_sem_t sem)
1393 return simcall_BODY_sem_get_capacity(sem);
1397 * \ingroup simix_file_management
1398 * \brief Returns the user data associated to a file.
1400 * \param fd A simix file
1401 * \return the user data of this file
1403 void* simcall_file_get_data(smx_file_t fd)
1405 return simcall_BODY_file_get_data(fd);
1409 * \ingroup simix_file_management
1410 * \brief Sets the user data associated to a file.
1412 * \param fd A SIMIX file
1413 * \param data The user data to set
1415 void simcall_file_set_data(smx_file_t fd, void *data)
1417 simcall_file_set_data(fd, data);
1421 * \ingroup simix_file_management
1424 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size)
1426 return simcall_BODY_file_read(fd, size);
1430 * \ingroup simix_file_management
1433 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size)
1435 return simcall_BODY_file_write(fd, size);
1439 * \ingroup simix_file_management
1442 smx_file_t simcall_file_open(const char* mount, const char* path)
1444 return simcall_BODY_file_open(mount, path);
1448 * \ingroup simix_file_management
1451 int simcall_file_close(smx_file_t fd)
1453 return simcall_BODY_file_close(fd);
1457 * \ingroup simix_file_management
1460 int simcall_file_unlink(smx_file_t fd)
1462 return simcall_BODY_file_unlink(fd);
1466 * \ingroup simix_file_management
1469 xbt_dict_t simcall_file_ls(const char* mount, const char* path)
1471 return simcall_BODY_file_ls(mount, path);
1474 * \ingroup simix_file_management
1477 sg_size_t simcall_file_get_size(smx_file_t fd){
1478 return simcall_BODY_file_get_size(fd);
1482 * \ingroup simix_file_management
1485 sg_size_t simcall_file_tell(smx_file_t fd){
1486 return simcall_BODY_file_tell(fd);
1490 * \ingroup simix_file_management
1493 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1495 return simcall_BODY_file_get_info(fd);
1499 * \ingroup simix_file_management
1502 int simcall_file_seek(smx_file_t fd, sg_size_t offset, int origin){
1503 return simcall_BODY_file_seek(fd, offset, origin);
1507 * \ingroup simix_file_management
1510 void simcall_storage_file_rename(smx_storage_t storage, const char* src, const char* dest)
1512 return simcall_BODY_storage_file_rename(storage, src, dest);
1516 * \ingroup simix_storage_management
1517 * \brief Returns the free space size on a given storage element.
1518 * \param storage name
1519 * \return Return the free space size on a given storage element (as sg_size_t)
1521 sg_size_t simcall_storage_get_free_size (const char* name){
1522 return simcall_BODY_storage_get_free_size(name);
1526 * \ingroup simix_storage_management
1527 * \brief Returns the used space size on a given storage element.
1528 * \param storage name
1529 * \return Return the used space size on a given storage element (as sg_size_t)
1531 sg_size_t simcall_storage_get_used_size (const char* name){
1532 return simcall_BODY_storage_get_used_size(name);
1536 * \ingroup simix_storage_management
1537 * \brief Returns the list of storages mounted on an host.
1538 * \param host A SIMIX host
1539 * \return a dict containing all storages mounted on the host
1541 xbt_dict_t simcall_host_get_storage_list(smx_host_t host)
1543 return simcall_BODY_host_get_storage_list(host);
1547 * \ingroup simix_storage_management
1548 * \brief Returns a dict of the properties assigned to a storage element.
1550 * \param storage A storage element
1551 * \return The properties of this storage element
1553 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1555 return simcall_BODY_storage_get_properties(storage);
1559 * \ingroup simix_storage_management
1560 * \brief Returns a dict containing the content of a storage element.
1562 * \param storage A storage element
1563 * \return The content of this storage element as a dict (full path file => size)
1565 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1567 return simcall_BODY_storage_get_content(storage);
1572 void *simcall_mc_snapshot(void)
1574 return simcall_BODY_mc_snapshot();
1577 int simcall_mc_compare_snapshots(void *s1, void *s2){
1578 return simcall_BODY_mc_compare_snapshots(s1, s2);
1581 int simcall_mc_random(int min, int max)
1583 return simcall_BODY_mc_random(min, max);
1587 #endif /* HAVE_MC */
1589 /* ****************************************************************************************** */
1590 /* TUTORIAL: New API */
1591 /* All functions for simcall */
1592 /* ****************************************************************************************** */
1593 int simcall_new_api_fct(const char* param1, double param2){
1594 smx_simcall_t simcall = SIMIX_simcall_mine();
1595 simcall->call = SIMCALL_NEW_API_INIT;
1596 simcall->new_api.param1 = param1;
1597 simcall->new_api.param2 = param2;
1599 SIMIX_simcall_push(simcall->issuer);
1600 return simcall->new_api.result;
1603 /* ************************************************************************** */
1605 /** @brief returns a printable string representing a simcall */
1606 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1607 return simcall_names[kind];