1 /* smx_user.c - public interface to simix */
3 /* Copyright (c) 2010-2012. Da SimGrid team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "smx_private.h"
11 #include <math.h> /* isfinite() */
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
15 /* generate strings from the enumeration values */
16 static const char* simcall_names[] = {
17 SIMCALL_LIST(SIMCALL_STRING_TYPE, SIMCALL_SEP_COMMA)
18 [SIMCALL_NONE] = "NONE"
21 SIMCALL_LIST(SIMCALL_FUNC, SIMCALL_SEP_NOTHING)
24 * \ingroup simix_host_management
25 * \brief Returns a host given its name.
27 * \param name The name of the host to get
28 * \return The corresponding host
30 smx_host_t simcall_host_get_by_name(const char *name)
32 return simcall_BODY_host_get_by_name(name);
36 * \ingroup simix_host_management
37 * \brief Returns the name of a host.
39 * \param host A SIMIX host
40 * \return The name of this host
42 const char* simcall_host_get_name(smx_host_t host)
44 return simcall_BODY_host_get_name(host);
48 * \ingroup simix_host_management
49 * \brief 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(smx_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);
73 * \ingroup simix_host_management
74 * \brief Returns the speed of the processor.
76 * The speed returned does not take into account the current load on the machine.
77 * \param host A SIMIX host
78 * \return The speed of this host (in Mflop/s)
80 double simcall_host_get_speed(smx_host_t host)
82 return simcall_BODY_host_get_speed(host);
86 * \ingroup simix_host_management
87 * \brief Returns the available speed of the processor.
89 * \return Speed currently available (in Mflop/s)
91 double simcall_host_get_available_speed(smx_host_t host)
93 return simcall_BODY_host_get_available_speed(host);
97 * \ingroup simix_host_management
98 * \brief Returns the state of a host.
100 * Two states are possible: 1 if the host is active or 0 if it has crashed.
101 * \param host A SIMIX host
102 * \return 1 if the host is available, 0 otherwise
104 int simcall_host_get_state(smx_host_t host)
106 return simcall_BODY_host_get_state(host);
110 * \ingroup simix_host_management
111 * \brief Returns the user data associated to a host.
113 * \param host SIMIX host
114 * \return the user data of this host
116 void* simcall_host_get_data(smx_host_t host)
118 return simcall_BODY_host_get_data(host);
122 * \ingroup simix_host_management
123 * \brief Sets the user data associated to a host.
125 * The host must not have previous user data associated to it.
126 * \param host A SIMIX host
127 * \param data The user data to set
129 void simcall_host_set_data(smx_host_t host, void *data)
131 simcall_host_set_data(host, data);
135 * \ingroup simix_host_management
136 * \brief Creates an action that executes some computation of an host.
138 * This function creates a SURF action and allocates the data necessary
139 * to create the SIMIX action. It can raise a host_error exception if the host crashed.
141 * \param name Name of the execution action to create
142 * \param host SIMIX host where the action will be executed
143 * \param computation_amount amount Computation amount (in bytes)
144 * \param priority computation priority
145 * \return A new SIMIX execution action
148 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
149 double computation_amount,
152 /* checking for infinite values */
153 xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
154 xbt_assert(isfinite(priority), "priority is not finite!");
156 return simcall_BODY_host_execute(name, host, computation_amount, priority);
160 * \ingroup simix_host_management
161 * \brief Creates an action that may involve parallel computation on
162 * several hosts and communication between them.
164 * \param name Name of the execution action to create
165 * \param host_nb Number of hosts where the action will be executed
166 * \param host_list Array (of size host_nb) of hosts where the action will be executed
167 * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
168 * \param communication_amount Array (of size host_nb * host_nb) representing the communication
169 * amount between each pair of hosts
170 * \param amount the SURF action amount
171 * \param rate the SURF action rate
172 * \return A new SIMIX execution action
174 smx_action_t simcall_host_parallel_execute(const char *name,
176 smx_host_t *host_list,
177 double *computation_amount,
178 double *communication_amount,
183 /* checking for infinite values */
184 for (i = 0 ; i < host_nb ; ++i) {
185 xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
186 for (j = 0 ; j < host_nb ; ++j) {
187 xbt_assert(isfinite(communication_amount[i + host_nb * j]),
188 "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
192 xbt_assert(isfinite(amount), "amount is not finite!");
193 xbt_assert(isfinite(rate), "rate is not finite!");
195 return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
197 communication_amount,
203 * \ingroup simix_host_management
204 * \brief Destroys an execution action.
206 * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
207 * \param execution The execution action to destroy
209 void simcall_host_execution_destroy(smx_action_t execution)
211 simcall_BODY_host_execution_destroy(execution);
215 * \ingroup simix_host_management
216 * \brief Cancels an execution action.
218 * This functions stops the execution. It calls a surf function.
219 * \param execution The execution action to cancel
221 void simcall_host_execution_cancel(smx_action_t execution)
223 simcall_BODY_host_execution_cancel(execution);
227 * \ingroup simix_host_management
228 * \brief Returns how much of an execution action remains to be done.
230 * \param execution The execution action
231 * \return The remaining amount
233 double simcall_host_execution_get_remains(smx_action_t execution)
235 return simcall_BODY_host_execution_get_remains(execution);
239 * \ingroup simix_host_management
240 * \brief Returns the state of an execution action.
242 * \param execution The execution action
245 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
247 return simcall_BODY_host_execution_get_state(execution);
251 * \ingroup simix_host_management
252 * \brief Changes the priority of an execution action.
254 * This functions changes the priority only. It calls a surf function.
255 * \param execution The execution action
256 * \param priority The new priority
258 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
260 /* checking for infinite values */
261 xbt_assert(isfinite(priority), "priority is not finite!");
263 simcall_BODY_host_execution_set_priority(execution, priority);
267 * \ingroup simix_host_management
268 * \brief Waits for the completion of an execution action and destroy it.
270 * \param execution The execution action
272 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
274 return simcall_BODY_host_execution_wait(execution);
279 * \ingroup simix_vm_management
280 * \brief Create a VM on the given physical host.
282 * \param name VM name
283 * \param host Physical host
285 * \return The host object of the VM
287 void* simcall_vm_create(const char *name, smx_host_t phys_host){
288 /* will jump to SIMIX_pre_vm_create() in src/simix/smx_smurf_private.h */
289 return simcall_BODY_vm_create(name, phys_host);
293 * \ingroup simix_vm_management
294 * \brief Start the given VM to the given physical host
298 void simcall_vm_start(smx_host_t vm)
300 /* will jump to SIMIX_pre_vm_start in src/simix/smx_smurf_private.h */
301 simcall_BODY_vm_start(vm);
305 * \ingroup simix_vm_management
306 * \brief Get the state of the given VM
309 * \return The state of the VM
311 int simcall_vm_get_state(smx_host_t vm)
313 /* will jump to SIMIX_pre_vm_get_state in src/simix/smx_smurf_private.h */
314 return simcall_BODY_vm_get_state(vm);
318 * \ingroup simix_vm_management
319 * \brief Get the name of the physical host on which the given VM runs.
322 * \return The name of the physical host
324 void *simcall_vm_get_pm(smx_host_t vm)
326 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
327 return simcall_BODY_vm_get_pm(vm);
330 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
332 /* will jump to SIMIX_pre_host_get_params in src/simix/smx_smurf_private.h */
333 simcall_BODY_host_get_params(vm, params);
336 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
338 /* will jump to SIMIX_pre_host_set_params in src/simix/smx_smurf_private.h */
339 simcall_BODY_host_set_params(vm, params);
343 * \ingroup simix_vm_management
344 * \brief Migrate the given VM to the given physical host
347 * \param host Destination physical host
349 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
351 /* will jump to SIMIX_pre_vm_migrate in src/simix/smx_smurf_private.h */
352 simcall_BODY_vm_migrate(vm, host);
356 * \ingroup simix_vm_management
357 * \brief Suspend the given VM
361 void simcall_vm_suspend(smx_host_t vm)
363 /* will jump to SIMIX_pre_vm_suspend in src/simix/smx_smurf_private.h */
364 simcall_BODY_vm_suspend(vm);
368 * \ingroup simix_vm_management
369 * \brief Resume the given VM
373 void simcall_vm_resume(smx_host_t vm)
375 /* will jump to SIMIX_pre_vm_resume in src/simix/smx_smurf_private.h */
376 simcall_BODY_vm_resume(vm);
380 * \ingroup simix_vm_management
381 * \brief Save the given VM
385 void simcall_vm_save(smx_host_t vm)
387 /* will jump to SIMIX_pre_vm_save in src/simix/smx_smurf_private.h */
388 simcall_BODY_vm_save(vm);
392 * \ingroup simix_vm_management
393 * \brief Restore the given VM
397 void simcall_vm_restore(smx_host_t vm)
399 /* will jump to SIMIX_pre_vm_restore in src/simix/smx_smurf_private.h */
400 simcall_BODY_vm_restore(vm);
404 * \ingroup simix_vm_management
405 * \brief Shutdown the given VM
409 void simcall_vm_shutdown(smx_host_t vm)
411 /* will jump to SIMIX_pre_vm_shutdown in src/simix/smx_smurf_private.h */
412 simcall_BODY_vm_shutdown(vm);
416 * \ingroup simix_vm_management
417 * \brief Destroy the given VM
421 void simcall_vm_destroy(smx_host_t vm)
423 /* will jump to SIMIX_pre_vm_destroy in src/simix/smx_smurf_private.h */
424 simcall_BODY_vm_destroy(vm);
429 * \ingroup simix_process_management
430 * \brief Creates and runs a new SIMIX process.
432 * The structure and the corresponding thread are created and put in the list of ready processes.
434 * \param process the process created will be stored in this pointer
435 * \param name a name for the process. It is for user-level information and can be NULL.
436 * \param code the main function of the process
437 * \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.
438 * It can be retrieved with the function \ref simcall_process_get_data.
439 * \param hostname name of the host where the new agent is executed.
440 * \param kill_time time when the process is killed
441 * \param argc first argument passed to \a code
442 * \param argv second argument passed to \a code
443 * \param properties the properties of the process
444 * \param auto_restart either it is autorestarting or not.
446 void simcall_process_create(smx_process_t *process, const char *name,
447 xbt_main_func_t code,
449 const char *hostname,
451 int argc, char **argv,
452 xbt_dict_t properties,
455 simcall_BODY_process_create(process, name, code, data, hostname,
456 kill_time, argc, argv, properties,
461 * \ingroup simix_process_management
462 * \brief Kills a SIMIX process.
464 * This function simply kills a process.
466 * \param process poor victim
468 void simcall_process_kill(smx_process_t process)
470 simcall_BODY_process_kill(process);
474 * \ingroup simix_process_management
475 * \brief Kills all SIMIX processes.
477 void simcall_process_killall(int reset_pid)
479 simcall_BODY_process_killall(reset_pid);
483 * \ingroup simix_process_management
484 * \brief Cleans up a SIMIX process.
485 * \param process poor victim (must have already been killed)
487 void simcall_process_cleanup(smx_process_t process)
489 simcall_BODY_process_cleanup(process);
493 * \ingroup simix_process_management
494 * \brief Migrates an agent to another location.
496 * This function changes the value of the host on which \a process is running.
498 * \param process the process to migrate
499 * \param dest name of the new host
501 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
503 simcall_BODY_process_change_host(process, dest);
507 * \ingroup simix_process_management
508 * \brief Suspends a process.
510 * This function suspends the process by suspending the action
511 * it was waiting for completion.
513 * \param process a SIMIX process
515 void simcall_process_suspend(smx_process_t process)
517 xbt_assert(process, "Invalid parameters");
519 simcall_BODY_process_suspend(process);
523 * \ingroup simix_process_management
524 * \brief Resumes a suspended process.
526 * This function resumes a suspended process by resuming the action
527 * it was waiting for completion.
529 * \param process a SIMIX process
531 void simcall_process_resume(smx_process_t process)
533 simcall_BODY_process_resume(process);
537 * \ingroup simix_process_management
538 * \brief Returns the amount of SIMIX processes in the system
540 * Maestro internal process is not counted, only user code processes are
542 int simcall_process_count(void)
544 return simcall_BODY_process_count();
548 * \ingroup simix_process_management
549 * \brief Return the PID of a #smx_process_t.
550 * \param process a SIMIX process
551 * \return the PID of this process
553 int simcall_process_get_PID(smx_process_t process)
555 if (process == SIMIX_process_self()) {
556 /* avoid a simcall if this function is called by the process itself */
557 return SIMIX_process_get_PID(process);
560 return simcall_BODY_process_get_PID(process);
564 * \ingroup simix_process_management
565 * \brief Return the parent PID of a #smx_process_t.
566 * \param process a SIMIX process
567 * \return the PID of this process parenrt
569 int simcall_process_get_PPID(smx_process_t process)
571 if (process == SIMIX_process_self()) {
572 /* avoid a simcall if this function is called by the process itself */
573 return SIMIX_process_get_PPID(process);
576 return simcall_BODY_process_get_PPID(process);
580 * \ingroup simix_process_management
581 * \brief Return the user data of a #smx_process_t.
582 * \param process a SIMIX process
583 * \return the user data of this process
585 void* simcall_process_get_data(smx_process_t process)
587 if (process == SIMIX_process_self()) {
588 /* avoid a simcall if this function is called by the process itself */
589 return SIMIX_process_get_data(process);
592 return simcall_BODY_process_get_data(process);
596 * \ingroup simix_process_management
597 * \brief Set the user data of a #smx_process_t.
599 * This functions sets the user data associated to \a process.
600 * \param process SIMIX process
601 * \param data User data
603 void simcall_process_set_data(smx_process_t process, void *data)
605 if (process == SIMIX_process_self()) {
606 /* avoid a simcall if this function is called by the process itself */
607 SIMIX_process_self_set_data(process, data);
610 simcall_BODY_process_set_data(process, data);
615 * \ingroup simix_process_management
616 * \brief Set the kill time of a process.
617 * \param process a process
618 * \param kill_time a double
620 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
623 if (kill_time > SIMIX_get_clock()) {
624 if (simix_global->kill_process_function) {
625 XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
626 sg_host_name(process->smx_host));
627 SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
633 * \ingroup simix_process_management
634 * \brief Return the location on which an agent is running.
636 * This functions returns the smx_host_t corresponding to the location on which
637 * \a process is running.
638 * \param process SIMIX process
641 smx_host_t simcall_process_get_host(smx_process_t process)
643 return simcall_BODY_process_get_host(process);
647 * \ingroup simix_process_management
648 * \brief Return the name of an agent.
650 * This functions checks whether \a process is a valid pointer or not and return its name.
651 * \param process SIMIX process
652 * \return The process name
654 const char* simcall_process_get_name(smx_process_t process)
656 if (process == SIMIX_process_self()) {
657 /* avoid a simcall if this function is called by the process itself */
658 return process->name;
660 return simcall_BODY_process_get_name(process);
664 * \ingroup simix_process_management
665 * \brief Returns true if the process is suspended .
667 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
668 * \param process SIMIX process
669 * \return 1, if the process is suspended, else 0.
671 int simcall_process_is_suspended(smx_process_t process)
673 return simcall_BODY_process_is_suspended(process);
677 * \ingroup simix_process_management
678 * \brief Return the properties
680 * This functions returns the properties associated with this process
682 xbt_dict_t simcall_process_get_properties(smx_process_t process)
684 return simcall_BODY_process_get_properties(process);
687 * \ingroup simix_process_management
688 * \brief Add an on_exit function
689 * Add an on_exit function which will be executed when the process exits/is killed.
691 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data)
693 simcall_BODY_process_on_exit(process, fun, data);
696 * \ingroup simix_process_management
697 * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
698 * Will restart the process when the host comes back up if auto_restart is set to 1.
701 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
703 simcall_BODY_process_auto_restart_set(process, auto_restart);
707 * \ingroup simix_process_management
708 * \brief Restarts the process, killing it and starting it again from scratch.
710 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
712 return simcall_BODY_process_restart(process);
715 * \ingroup simix_process_management
716 * \brief Creates a new sleep SIMIX action.
718 * This function creates a SURF action and allocates the data necessary
719 * to create the SIMIX action. It can raise a host_error exception if the
720 * host crashed. The default SIMIX name of the action is "sleep".
722 * \param duration Time duration of the sleep.
723 * \return A result telling whether the sleep was successful
725 e_smx_state_t simcall_process_sleep(double duration)
727 /* checking for infinite values */
728 xbt_assert(isfinite(duration), "duration is not finite!");
729 return simcall_BODY_process_sleep(duration);
733 * \ingroup simix_rdv_management
734 * \brief Creates a new rendez-vous point
735 * \param name The name of the rendez-vous point
736 * \return The created rendez-vous point
738 smx_rdv_t simcall_rdv_create(const char *name)
740 return simcall_BODY_rdv_create(name);
745 * \ingroup simix_rdv_management
746 * \brief Destroy a rendez-vous point
747 * \param rdv The rendez-vous point to destroy
749 void simcall_rdv_destroy(smx_rdv_t rdv)
751 simcall_BODY_rdv_destroy(rdv);
754 * \ingroup simix_rdv_management
755 * \brief Returns a rendez-vous point knowing its name
757 smx_rdv_t simcall_rdv_get_by_name(const char *name)
759 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
761 /* FIXME: this is a horrible loss of performance, so we hack it out by
762 * skipping the simcall (for now). It works in parallel, it won't work on
763 * distributed but probably we will change MSG for that. */
766 smx_simcall_t simcall = simcall_mine();
767 simcall->call = SIMCALL_RDV_GEY_BY_NAME;
768 simcall->rdv_get_by_name.name = name;
769 SIMIX_simcall_push(simcall->issuer);
770 return simcall->rdv_get_by_name.result;*/
772 return SIMIX_rdv_get_by_name(name);
776 * \ingroup simix_rdv_management
777 * \brief Counts the number of communication actions of a given host pending
778 * on a rendez-vous point.
779 * \param rdv The rendez-vous point
780 * \param host The host to be counted
781 * \return The number of comm actions pending in the rdv
783 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
785 return simcall_BODY_rdv_comm_count_by_host(rdv, host);
789 * \ingroup simix_rdv_management
790 * \brief returns the communication at the head of the rendez-vous
791 * \param rdv The rendez-vous point
792 * \return The communication or NULL if empty
794 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
796 return simcall_BODY_rdv_get_head(rdv);
799 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
801 simcall_BODY_rdv_set_receiver(rdv, process);
804 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
806 return simcall_BODY_rdv_get_receiver(rdv);
810 * \ingroup simix_comm_management
812 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
813 void *src_buff, size_t src_buff_size,
814 int (*match_fun)(void *, void *, smx_action_t), void *data,
817 /* checking for infinite values */
818 xbt_assert(isfinite(task_size), "task_size is not finite!");
819 xbt_assert(isfinite(rate), "rate is not finite!");
820 xbt_assert(isfinite(timeout), "timeout is not finite!");
822 xbt_assert(rdv, "No rendez-vous point defined for send");
824 if (MC_is_active()) {
825 /* the model-checker wants two separate simcalls */
826 smx_action_t comm = simcall_comm_isend(rdv, task_size, rate,
827 src_buff, src_buff_size, match_fun, NULL, data, 0);
828 simcall_comm_wait(comm, timeout);
831 simcall_BODY_comm_send(rdv, task_size, rate, src_buff, src_buff_size,
832 match_fun, data, timeout);
837 * \ingroup simix_comm_management
839 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
840 void *src_buff, size_t src_buff_size,
841 int (*match_fun)(void *, void *, smx_action_t),
842 void (*clean_fun)(void *),
846 /* checking for infinite values */
847 xbt_assert(isfinite(task_size), "task_size is not finite!");
848 xbt_assert(isfinite(rate), "rate is not finite!");
850 xbt_assert(rdv, "No rendez-vous point defined for isend");
852 return simcall_BODY_comm_isend(rdv, task_size, rate, src_buff,
853 src_buff_size, match_fun,
854 clean_fun, data, detached);
857 * \ingroup simix_comm_management
859 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
860 int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
862 xbt_assert(isfinite(timeout), "timeout is not finite!");
863 xbt_assert(rdv, "No rendez-vous point defined for recv");
865 if (MC_is_active()) {
866 /* the model-checker wants two separate simcalls */
867 smx_action_t comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
869 simcall_comm_wait(comm, timeout);
872 simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
873 match_fun, data, timeout);
877 * \ingroup simix_comm_management
879 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
880 int (*match_fun)(void *, void *, smx_action_t), void *data)
882 xbt_assert(rdv, "No rendez-vous point defined for irecv");
884 return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
890 * \ingroup simix_comm_management
892 void simcall_comm_recv_bounded(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
893 int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout, double rate)
895 xbt_assert(isfinite(timeout), "timeout is not finite!");
896 xbt_assert(rdv, "No rendez-vous point defined for recv");
898 if (MC_is_active()) {
899 /* the model-checker wants two separate simcalls */
900 smx_action_t comm = simcall_comm_irecv_bounded(rdv, dst_buff, dst_buff_size,
901 match_fun, data, rate);
902 simcall_comm_wait(comm, timeout);
905 simcall_BODY_comm_recv_bounded(rdv, dst_buff, dst_buff_size,
906 match_fun, data, timeout, rate);
910 * \ingroup simix_comm_management
912 smx_action_t simcall_comm_irecv_bounded(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
913 int (*match_fun)(void *, void *, smx_action_t), void *data, double rate)
915 xbt_assert(rdv, "No rendez-vous point defined for irecv");
917 return simcall_BODY_comm_irecv_bounded(rdv, dst_buff, dst_buff_size,
918 match_fun, data, rate);
923 * \ingroup simix_comm_management
925 smx_action_t simcall_comm_iprobe(smx_rdv_t rdv, int src, int tag,
926 int (*match_fun)(void *, void *, smx_action_t), void *data)
928 xbt_assert(rdv, "No rendez-vous point defined for iprobe");
930 return simcall_BODY_comm_iprobe(rdv, src, tag, match_fun, data);
933 void simcall_comm_destroy(smx_action_t comm)
935 xbt_assert(comm, "Invalid parameter");
937 /* FIXME remove this simcall type: comms are auto-destroyed now */
940 smx_simcall_t simcall = simcall_mine();
942 simcall->call = SIMCALL_COMM_DESTROY;
943 simcall->comm_destroy.comm = comm;
945 SIMIX_simcall_push(simcall->issuer);
950 * \ingroup simix_comm_management
952 void simcall_comm_cancel(smx_action_t comm)
954 simcall_BODY_comm_cancel(comm);
958 * \ingroup simix_comm_management
960 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
962 return simcall_BODY_comm_waitany(comms);
966 * \ingroup simix_comm_management
968 int simcall_comm_testany(xbt_dynar_t comms)
970 if (xbt_dynar_is_empty(comms))
972 return simcall_BODY_comm_testany(comms);
976 * \ingroup simix_comm_management
978 void simcall_comm_wait(smx_action_t comm, double timeout)
980 xbt_assert(isfinite(timeout), "timeout is not finite!");
981 simcall_BODY_comm_wait(comm, timeout);
986 * \brief Set the category of an action.
988 * This functions changes the category only. It calls a surf function.
989 * \param execution The execution action
990 * \param category The tracing category
992 void simcall_set_category(smx_action_t action, const char *category)
994 if (category == NULL) {
997 simcall_BODY_set_category(action, category);
1002 * \ingroup simix_comm_management
1005 int simcall_comm_test(smx_action_t comm)
1007 return simcall_BODY_comm_test(comm);
1011 * \ingroup simix_comm_management
1014 double simcall_comm_get_remains(smx_action_t comm)
1016 return simcall_BODY_comm_get_remains(comm);
1020 * \ingroup simix_comm_management
1023 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
1025 return simcall_BODY_comm_get_state(comm);
1029 * \ingroup simix_comm_management
1032 void *simcall_comm_get_src_data(smx_action_t comm)
1034 return simcall_BODY_comm_get_src_data(comm);
1038 * \ingroup simix_comm_management
1041 void *simcall_comm_get_dst_data(smx_action_t comm)
1043 return simcall_BODY_comm_get_dst_data(comm);
1047 * \ingroup simix_comm_management
1050 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
1052 return simcall_BODY_comm_get_src_proc(comm);
1056 * \ingroup simix_comm_management
1059 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
1061 return simcall_BODY_comm_get_dst_proc(comm);
1064 #ifdef HAVE_LATENCY_BOUND_TRACKING
1065 int simcall_comm_is_latency_bounded(smx_action_t comm)
1067 return simcall_BODY_comm_is_latency_bounded(comm);
1072 * \ingroup simix_synchro_management
1075 smx_mutex_t simcall_mutex_init(void)
1078 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
1081 return simcall_BODY_mutex_init();
1085 * \ingroup simix_synchro_management
1088 void simcall_mutex_destroy(smx_mutex_t mutex)
1090 simcall_BODY_mutex_destroy(mutex);
1094 * \ingroup simix_synchro_management
1097 void simcall_mutex_lock(smx_mutex_t mutex)
1099 simcall_BODY_mutex_lock(mutex);
1103 * \ingroup simix_synchro_management
1106 int simcall_mutex_trylock(smx_mutex_t mutex)
1108 return simcall_BODY_mutex_trylock(mutex);
1112 * \ingroup simix_synchro_management
1115 void simcall_mutex_unlock(smx_mutex_t mutex)
1117 simcall_BODY_mutex_unlock(mutex);
1121 * \ingroup simix_synchro_management
1124 smx_cond_t simcall_cond_init(void)
1126 return simcall_BODY_cond_init();
1130 * \ingroup simix_synchro_management
1133 void simcall_cond_destroy(smx_cond_t cond)
1135 simcall_BODY_cond_destroy(cond);
1139 * \ingroup simix_synchro_management
1142 void simcall_cond_signal(smx_cond_t cond)
1144 simcall_BODY_cond_signal(cond);
1148 * \ingroup simix_synchro_management
1151 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1153 simcall_BODY_cond_wait(cond, mutex);
1157 * \ingroup simix_synchro_management
1160 void simcall_cond_wait_timeout(smx_cond_t cond,
1164 xbt_assert(isfinite(timeout), "timeout is not finite!");
1165 simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1169 * \ingroup simix_synchro_management
1172 void simcall_cond_broadcast(smx_cond_t cond)
1174 simcall_BODY_cond_broadcast(cond);
1178 * \ingroup simix_synchro_management
1181 smx_sem_t simcall_sem_init(int capacity)
1183 return simcall_BODY_sem_init(capacity);
1187 * \ingroup simix_synchro_management
1190 void simcall_sem_destroy(smx_sem_t sem)
1192 simcall_sem_destroy(sem);
1196 * \ingroup simix_synchro_management
1199 void simcall_sem_release(smx_sem_t sem)
1201 simcall_BODY_sem_release(sem);
1205 * \ingroup simix_synchro_management
1208 int simcall_sem_would_block(smx_sem_t sem)
1210 return simcall_BODY_sem_would_block(sem);
1214 * \ingroup simix_synchro_management
1217 void simcall_sem_acquire(smx_sem_t sem)
1219 simcall_BODY_sem_acquire(sem);
1223 * \ingroup simix_synchro_management
1226 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1228 xbt_assert(isfinite(timeout), "timeout is not finite!");
1229 simcall_BODY_sem_acquire_timeout(sem, timeout);
1233 * \ingroup simix_synchro_management
1236 int simcall_sem_get_capacity(smx_sem_t sem)
1238 return simcall_BODY_sem_get_capacity(sem);
1242 * \ingroup simix_file_management
1245 double simcall_file_read(void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1247 return simcall_BODY_file_read(ptr, size, nmemb, stream);
1251 * \ingroup simix_file_management
1254 size_t simcall_file_write(const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1256 return simcall_BODY_file_write(ptr, size, nmemb, stream);
1260 * \ingroup simix_file_management
1263 smx_file_t simcall_file_open(const char* mount, const char* path, const char* mode)
1265 return simcall_BODY_file_open(mount, path, mode);
1269 * \ingroup simix_file_management
1272 int simcall_file_close(smx_file_t fp)
1274 return simcall_BODY_file_close(fp);
1278 * \ingroup simix_file_management
1281 int simcall_file_stat(smx_file_t fd, s_file_stat_t *buf)
1283 return simcall_BODY_file_stat(fd, buf);
1287 * \ingroup simix_file_management
1290 int simcall_file_unlink(smx_file_t fd)
1292 return simcall_BODY_file_unlink(fd);
1296 * \ingroup simix_file_management
1299 xbt_dict_t simcall_file_ls(const char* mount, const char* path)
1301 return simcall_BODY_file_ls(mount, path);
1306 void *simcall_mc_snapshot(void)
1308 return simcall_BODY_mc_snapshot();
1311 int simcall_mc_compare_snapshots(void *s1, void *s2){
1312 return simcall_BODY_mc_compare_snapshots(s1, s2);
1315 int simcall_mc_random(void)
1317 return simcall_BODY_mc_random();
1321 #endif /* HAVE_MC */
1323 /* ****************************************************************************************** */
1324 /* TUTORIAL: New API */
1325 /* All functions for simcall */
1326 /* ****************************************************************************************** */
1327 int simcall_new_api_fct(const char* param1, double param2){
1328 smx_simcall_t simcall = SIMIX_simcall_mine();
1329 simcall->call = SIMCALL_NEW_API_INIT;
1330 simcall->new_api.param1 = param1;
1331 simcall->new_api.param2 = param2;
1333 SIMIX_simcall_push(simcall->issuer);
1334 return simcall->new_api.result;
1337 /* ************************************************************************** */
1339 /** @brief returns a printable string representing a simcall */
1340 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1341 return simcall_names[kind];