Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add vm_suspend stuff
[simgrid.git] / src / simix / smx_user.c
1 /* smx_user.c - public interface to simix                                   */
2
3 /* Copyright (c) 2010-2012. Da SimGrid team. All rights reserved.          */
4
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. */
7
8 #include "smx_private.h"
9 #include "mc/mc.h"
10 #include "xbt/ex.h"
11 #include <math.h>         /* isfinite() */
12
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
14
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"
19 };
20
21 SIMCALL_LIST(SIMCALL_FUNC, SIMCALL_SEP_NOTHING)
22
23 /**
24  * \ingroup simix_host_management
25  * \brief Returns a host given its name.
26  *
27  * \param name The name of the host to get
28  * \return The corresponding host
29  */
30 smx_host_t simcall_host_get_by_name(const char *name)
31 {
32   return simcall_BODY_host_get_by_name(name);
33 }
34
35 /**
36  * \ingroup simix_host_management
37  * \brief Returns the name of a host.
38  *
39  * \param host A SIMIX host
40  * \return The name of this host
41  */
42 const char* simcall_host_get_name(smx_host_t host)
43 {
44   return simcall_BODY_host_get_name(host);
45 }
46
47 /**
48  * \ingroup simix_host_management
49  * \brief Returns a dict of the properties assigned to a host.
50  *
51  * \param host A host
52  * \return The properties of this host
53  */
54 xbt_dict_t simcall_host_get_properties(smx_host_t host)
55 {
56   return simcall_BODY_host_get_properties(host);
57 }
58
59 /**
60  * \ingroup simix_host_management
61  * \brief Returns a dict of the properties assigned to a router or AS.
62  *
63  * \param name The name of the router or AS
64  * \return The properties
65  */
66 xbt_dict_t simcall_asr_get_properties(const char *name)
67 {
68   return simcall_BODY_asr_get_properties(name);
69 }
70
71
72 /**
73  * \ingroup simix_host_management
74  * \brief Returns the speed of the processor.
75  *
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)
79  */
80 double simcall_host_get_speed(smx_host_t host)
81 {
82   return simcall_BODY_host_get_speed(host);
83 }
84
85 /**
86  * \ingroup simix_host_management
87  * \brief Returns the available speed of the processor.
88  *
89  * \return Speed currently available (in Mflop/s)
90  */
91 double simcall_host_get_available_speed(smx_host_t host)
92 {
93   return simcall_BODY_host_get_available_speed(host);
94 }
95
96 /**
97  * \ingroup simix_host_management
98  * \brief Returns the state of a host.
99  *
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
103  */
104 int simcall_host_get_state(smx_host_t host)
105 {
106   return simcall_BODY_host_get_state(host);
107 }
108
109 /**
110  * \ingroup simix_host_management
111  * \brief Returns the user data associated to a host.
112  *
113  * \param host SIMIX host
114  * \return the user data of this host
115  */
116 void* simcall_host_get_data(smx_host_t host)
117 {
118   return simcall_BODY_host_get_data(host);
119 }
120
121 /**
122  * \ingroup simix_host_management
123  * \brief Sets the user data associated to a host.
124  *
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
128  */
129 void simcall_host_set_data(smx_host_t host, void *data)
130 {
131   simcall_host_set_data(host, data);
132 }
133
134 /**
135  * \ingroup simix_host_management
136  * \brief Creates an action that executes some computation of an host.
137  *
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.
140  *
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
146  */
147
148 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
149                                     double computation_amount,
150                                     double priority)
151 {
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!");
155   
156   return simcall_BODY_host_execute(name, host, computation_amount, priority);
157 }
158
159 /**
160  * \ingroup simix_host_management
161  * \brief Creates an action that may involve parallel computation on
162  * several hosts and communication between them.
163  *
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
173  */
174 smx_action_t simcall_host_parallel_execute(const char *name,
175                                          int host_nb,
176                                          smx_host_t *host_list,
177                                          double *computation_amount,
178                                          double *communication_amount,
179                                          double amount,
180                                          double rate)
181 {
182   int i,j;
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);
189      }   
190   }   
191  
192   xbt_assert(isfinite(amount), "amount is not finite!");
193   xbt_assert(isfinite(rate), "rate is not finite!");
194   
195   return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
196                                             computation_amount,
197                                             communication_amount,
198                                             amount, rate);
199
200 }
201
202 /**
203  * \ingroup simix_host_management
204  * \brief Destroys an execution action.
205  *
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
208  */
209 void simcall_host_execution_destroy(smx_action_t execution)
210 {
211   simcall_BODY_host_execution_destroy(execution);
212 }
213
214 /**
215  * \ingroup simix_host_management
216  * \brief Cancels an execution action.
217  *
218  * This functions stops the execution. It calls a surf function.
219  * \param execution The execution action to cancel
220  */
221 void simcall_host_execution_cancel(smx_action_t execution)
222 {
223   simcall_BODY_host_execution_cancel(execution);
224 }
225
226 /**
227  * \ingroup simix_host_management
228  * \brief Returns how much of an execution action remains to be done.
229  *
230  * \param execution The execution action
231  * \return The remaining amount
232  */
233 double simcall_host_execution_get_remains(smx_action_t execution)
234 {
235   return simcall_BODY_host_execution_get_remains(execution);
236 }
237
238 /**
239  * \ingroup simix_host_management
240  * \brief Returns the state of an execution action.
241  *
242  * \param execution The execution action
243  * \return The state
244  */
245 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
246 {
247   return simcall_BODY_host_execution_get_state(execution);
248 }
249
250 /**
251  * \ingroup simix_host_management
252  * \brief Changes the priority of an execution action.
253  *
254  * This functions changes the priority only. It calls a surf function.
255  * \param execution The execution action
256  * \param priority The new priority
257  */
258 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
259 {
260   /* checking for infinite values */
261   xbt_assert(isfinite(priority), "priority is not finite!");
262   
263   simcall_BODY_host_execution_set_priority(execution, priority);
264 }
265
266 /**
267  * \ingroup simix_host_management
268  * \brief Waits for the completion of an execution action and destroy it.
269  *
270  * \param execution The execution action
271  */
272 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
273 {
274   return simcall_BODY_host_execution_wait(execution);
275 }
276
277
278 /**
279  * \ingroup simix_vm_management
280  * \brief Returns a dict of the properties assigned to a host.
281  *
282  * \param host A host
283  * \return The properties of this host
284  */
285 void* simcall_vm_create(const char *name, smx_host_t phys_host)
286 {
287   return simcall_BODY_vm_create(name, phys_host);
288 }
289
290 void simcall_vm_start(smx_host_t vm)
291 {
292   simcall_BODY_set_vm_state(vm, msg_vm_state_running);
293 }
294
295 void simcall_vm_suspend(smx_host_t vm)
296 {
297   /* will jump to SIMIX_pre_vm_suspend */
298   simcall_BODY_vm_suspend(vm);
299 }
300
301 void simcall_vm_shutdown(smx_host_t vm)
302 {
303   /* will jump to SIMIX_pre_vm_shutdown */
304   simcall_BODY_vm_shutdown(vm);
305 }
306
307 void simcall_vm_destroy(smx_host_t vm)
308 {
309   /*
310    * simcall_BODY_ is defined in src/simix/smx_smurf_private.h.
311    * This function will jump to SIMIX_pre_vm_destroy.
312    **/
313   simcall_BODY_vm_destroy(vm);
314 }
315
316 /**
317  * \ingroup simix_process_management
318  * \brief Creates and runs a new SIMIX process.
319  *
320  * The structure and the corresponding thread are created and put in the list of ready processes.
321  *
322  * \param process the process created will be stored in this pointer
323  * \param name a name for the process. It is for user-level information and can be NULL.
324  * \param code the main function of the process
325  * \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.
326  * It can be retrieved with the function \ref simcall_process_get_data.
327  * \param hostname name of the host where the new agent is executed.
328  * \param kill_time time when the process is killed
329  * \param argc first argument passed to \a code
330  * \param argv second argument passed to \a code
331  * \param properties the properties of the process
332  * \param auto_restart either it is autorestarting or not.
333  */
334 void simcall_process_create(smx_process_t *process, const char *name,
335                               xbt_main_func_t code,
336                               void *data,
337                               const char *hostname,
338                               double kill_time,
339                               int argc, char **argv,
340                               xbt_dict_t properties,
341                               int auto_restart)
342 {
343   simcall_BODY_process_create(process, name, code, data, hostname,
344                               kill_time, argc, argv, properties,
345                               auto_restart);
346 }
347
348 /**
349  * \ingroup simix_process_management
350  * \brief Kills a SIMIX process.
351  *
352  * This function simply kills a  process.
353  *
354  * \param process poor victim
355  */
356 void simcall_process_kill(smx_process_t process)
357 {
358   simcall_BODY_process_kill(process);
359 }
360
361 /**
362  * \ingroup simix_process_management
363  * \brief Kills all SIMIX processes.
364  */
365 void simcall_process_killall(void)
366 {
367   simcall_BODY_process_killall();
368 }
369
370 /**
371  * \ingroup simix_process_management
372  * \brief Cleans up a SIMIX process.
373  * \param process poor victim (must have already been killed)
374  */
375 void simcall_process_cleanup(smx_process_t process)
376 {
377   simcall_BODY_process_cleanup(process);
378 }
379
380 /**
381  * \ingroup simix_process_management
382  * \brief Migrates an agent to another location.
383  *
384  * This function changes the value of the host on which \a process is running.
385  *
386  * \param process the process to migrate
387  * \param dest name of the new host
388  */
389 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
390 {
391   simcall_BODY_process_change_host(process, dest);
392 }
393
394 /**
395  * \ingroup simix_process_management
396  * \brief Suspends a process.
397  *
398  * This function suspends the process by suspending the action
399  * it was waiting for completion.
400  *
401  * \param process a SIMIX process
402  */
403 void simcall_process_suspend(smx_process_t process)
404 {
405   xbt_assert(process, "Invalid parameters");
406
407   simcall_BODY_process_suspend(process);
408 }
409
410 /**
411  * \ingroup simix_process_management
412  * \brief Resumes a suspended process.
413  *
414  * This function resumes a suspended process by resuming the action
415  * it was waiting for completion.
416  *
417  * \param process a SIMIX process
418  */
419 void simcall_process_resume(smx_process_t process)
420 {
421   simcall_BODY_process_resume(process);
422 }
423
424 /**
425  * \ingroup simix_process_management
426  * \brief Returns the amount of SIMIX processes in the system
427  *
428  * Maestro internal process is not counted, only user code processes are
429  */
430 int simcall_process_count(void)
431 {
432   return simcall_BODY_process_count();
433 }
434
435 /**
436  * \ingroup simix_process_management
437  * \brief Return the user data of a #smx_process_t.
438  * \param process a SIMIX process
439  * \return the user data of this process
440  */
441 void* simcall_process_get_data(smx_process_t process)
442 {
443   if (process == SIMIX_process_self()) {
444     /* avoid a simcall if this function is called by the process itself */
445     return SIMIX_process_get_data(process);
446   }
447
448   return simcall_BODY_process_get_data(process);
449 }
450
451 /**
452  * \ingroup simix_process_management
453  * \brief Set the user data of a #smx_process_t.
454  *
455  * This functions sets the user data associated to \a process.
456  * \param process SIMIX process
457  * \param data User data
458  */
459 void simcall_process_set_data(smx_process_t process, void *data)
460 {
461   if (process == SIMIX_process_self()) {
462     /* avoid a simcall if this function is called by the process itself */
463     SIMIX_process_self_set_data(process, data);
464   }
465   else {
466     simcall_BODY_process_set_data(process, data);
467   }
468 }
469
470 /**
471  * \ingroup simix_process_management
472  * \brief Set the kill time of a process.
473  * \param process a process
474  * \param kill_time a double
475  */
476 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
477 {
478
479   if (kill_time > SIMIX_get_clock()) {
480     if (simix_global->kill_process_function) {
481       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
482           sg_host_name(process->smx_host));
483       SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
484     }
485   }
486 }
487
488 /**
489  * \ingroup simix_process_management
490  * \brief Return the location on which an agent is running.
491  *
492  * This functions returns the smx_host_t corresponding to the location on which
493  * \a process is running.
494  * \param process SIMIX process
495  * \return SIMIX host
496  */
497 smx_host_t simcall_process_get_host(smx_process_t process)
498 {
499   return simcall_BODY_process_get_host(process);
500 }
501
502 /**
503  * \ingroup simix_process_management
504  * \brief Return the name of an agent.
505  *
506  * This functions checks whether \a process is a valid pointer or not and return its name.
507  * \param process SIMIX process
508  * \return The process name
509  */
510 const char* simcall_process_get_name(smx_process_t process)
511 {
512   if (process == SIMIX_process_self()) {
513     /* avoid a simcall if this function is called by the process itself */
514     return process->name;
515   }
516   return simcall_BODY_process_get_name(process);
517 }
518
519 /**
520  * \ingroup simix_process_management
521  * \brief Returns true if the process is suspended .
522  *
523  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
524  * \param process SIMIX process
525  * \return 1, if the process is suspended, else 0.
526  */
527 int simcall_process_is_suspended(smx_process_t process)
528 {
529   return  simcall_BODY_process_is_suspended(process);
530 }
531
532 /**
533  * \ingroup simix_process_management
534  * \brief Return the properties
535  *
536  * This functions returns the properties associated with this process
537  */
538 xbt_dict_t simcall_process_get_properties(smx_process_t process)
539 {
540   return simcall_BODY_process_get_properties(process);
541 }
542 /**
543  * \ingroup simix_process_management
544  * \brief Add an on_exit function
545  * Add an on_exit function which will be executed when the process exits/is killed.
546  */
547 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data)
548 {
549   simcall_BODY_process_on_exit(process, fun, data);
550 }
551 /**
552  * \ingroup simix_process_management
553  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
554  * Will restart the process when the host comes back up if auto_restart is set to 1.
555  */
556
557 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
558 {
559   simcall_BODY_process_auto_restart_set(process, auto_restart);
560 }
561
562 /**
563  * \ingroup simix_process_management
564  * \brief Restarts the process, killing it and starting it again from scratch.
565  */
566 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
567 {
568   return simcall_BODY_process_restart(process);
569 }
570 /**
571  * \ingroup simix_process_management
572  * \brief Creates a new sleep SIMIX action.
573  *
574  * This function creates a SURF action and allocates the data necessary
575  * to create the SIMIX action. It can raise a host_error exception if the
576  * host crashed. The default SIMIX name of the action is "sleep".
577  *
578  *   \param duration Time duration of the sleep.
579  *   \return A result telling whether the sleep was successful
580  */
581 e_smx_state_t simcall_process_sleep(double duration)
582 {
583   /* checking for infinite values */
584   xbt_assert(isfinite(duration), "duration is not finite!");
585   return simcall_BODY_process_sleep(duration);
586 }
587
588 /**
589  *  \ingroup simix_rdv_management
590  *  \brief Creates a new rendez-vous point
591  *  \param name The name of the rendez-vous point
592  *  \return The created rendez-vous point
593  */
594 smx_rdv_t simcall_rdv_create(const char *name)
595 {
596   return simcall_BODY_rdv_create(name);
597 }
598
599
600 /**
601  *  \ingroup simix_rdv_management
602  *  \brief Destroy a rendez-vous point
603  *  \param rdv The rendez-vous point to destroy
604  */
605 void simcall_rdv_destroy(smx_rdv_t rdv)
606 {
607   simcall_BODY_rdv_destroy(rdv);
608 }
609 /**
610  *  \ingroup simix_rdv_management
611  *  \brief Returns a rendez-vous point knowing its name
612  */
613 smx_rdv_t simcall_rdv_get_by_name(const char *name)
614 {
615   xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
616
617   /* FIXME: this is a horrible lost of performance, so we hack it out by
618    * skipping the simcall (for now). It works in parallel, it won't work on
619    * distributed but probably we will change MSG for that. */
620
621   /*
622   smx_simcall_t simcall = simcall_mine();
623   simcall->call = SIMCALL_RDV_GEY_BY_NAME;
624   simcall->rdv_get_by_name.name = name;
625   SIMIX_simcall_push(simcall->issuer);
626   return simcall->rdv_get_by_name.result;*/
627
628   return SIMIX_rdv_get_by_name(name);
629 }
630
631 /**
632  *  \ingroup simix_rdv_management
633  *  \brief Counts the number of communication actions of a given host pending
634  *         on a rendez-vous point.
635  *  \param rdv The rendez-vous point
636  *  \param host The host to be counted
637  *  \return The number of comm actions pending in the rdv
638  */
639 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
640 {
641   return simcall_BODY_rdv_comm_count_by_host(rdv, host);
642 }
643
644 /**
645  *  \ingroup simix_rdv_management
646  *  \brief returns the communication at the head of the rendez-vous
647  *  \param rdv The rendez-vous point
648  *  \return The communication or NULL if empty
649  */
650 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
651 {
652   return simcall_BODY_rdv_get_head(rdv);
653 }
654
655 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
656 {
657   simcall_BODY_rdv_set_receiver(rdv, process);
658 }
659
660 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
661 {
662   return simcall_BODY_rdv_get_receiver(rdv);
663 }
664
665 /**
666  * \ingroup simix_comm_management
667  */
668 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
669                          void *src_buff, size_t src_buff_size,
670                          int (*match_fun)(void *, void *, smx_action_t), void *data,
671                          double timeout)
672 {
673   /* checking for infinite values */
674   xbt_assert(isfinite(task_size), "task_size is not finite!");
675   xbt_assert(isfinite(rate), "rate is not finite!");
676   xbt_assert(isfinite(timeout), "timeout is not finite!");
677   
678   xbt_assert(rdv, "No rendez-vous point defined for send");
679
680   if (MC_is_active()) {
681     /* the model-checker wants two separate simcalls */
682     smx_action_t comm = simcall_comm_isend(rdv, task_size, rate,
683         src_buff, src_buff_size, match_fun, NULL, data, 0);
684     simcall_comm_wait(comm, timeout);
685   }
686   else {
687     simcall_BODY_comm_send(rdv, task_size, rate, src_buff, src_buff_size,
688                          match_fun, data, timeout);
689   }
690 }
691
692 /**
693  * \ingroup simix_comm_management
694  */
695 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
696                               void *src_buff, size_t src_buff_size,
697                               int (*match_fun)(void *, void *, smx_action_t),
698                               void (*clean_fun)(void *),
699                               void *data,
700                               int detached)
701 {
702   /* checking for infinite values */
703   xbt_assert(isfinite(task_size), "task_size is not finite!");
704   xbt_assert(isfinite(rate), "rate is not finite!");
705   
706   xbt_assert(rdv, "No rendez-vous point defined for isend");
707
708   return simcall_BODY_comm_isend(rdv, task_size, rate, src_buff,
709                                  src_buff_size, match_fun,
710                                  clean_fun, data, detached);
711 }
712 /**
713  * \ingroup simix_comm_management
714  */
715 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
716                          int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
717 {
718   xbt_assert(isfinite(timeout), "timeout is not finite!");
719   xbt_assert(rdv, "No rendez-vous point defined for recv");
720
721   if (MC_is_active()) {
722     /* the model-checker wants two separate simcalls */
723     smx_action_t comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
724         match_fun, data);
725     simcall_comm_wait(comm, timeout);
726   }
727   else {
728     simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
729                            match_fun, data, timeout);
730   }
731 }
732 /**
733  * \ingroup simix_comm_management
734  */
735 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
736                                   int (*match_fun)(void *, void *, smx_action_t), void *data)
737 {
738   xbt_assert(rdv, "No rendez-vous point defined for irecv");
739
740   return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size, 
741                                  match_fun, data);
742 }
743
744
745 /**
746  * \ingroup simix_comm_management
747  */
748 smx_action_t simcall_comm_iprobe(smx_rdv_t rdv, int src, int tag,
749                                 int (*match_fun)(void *, void *, smx_action_t), void *data)
750 {
751   xbt_assert(rdv, "No rendez-vous point defined for iprobe");
752
753   return simcall_BODY_comm_iprobe(rdv, src, tag, match_fun, data);
754 }
755
756 void simcall_comm_destroy(smx_action_t comm)
757 {
758   xbt_assert(comm, "Invalid parameter");
759
760   /* FIXME remove this simcall type: comms are auto-destroyed now */
761
762   /*
763   smx_simcall_t simcall = simcall_mine();
764
765   simcall->call = SIMCALL_COMM_DESTROY;
766   simcall->comm_destroy.comm = comm;
767
768   SIMIX_simcall_push(simcall->issuer);
769   */
770 }
771
772 /**
773  * \ingroup simix_comm_management
774  */
775 void simcall_comm_cancel(smx_action_t comm)
776 {
777   simcall_BODY_comm_cancel(comm);
778 }
779
780 /**
781  * \ingroup simix_comm_management
782  */
783 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
784 {
785   return simcall_BODY_comm_waitany(comms);
786 }
787
788 /**
789  * \ingroup simix_comm_management
790  */
791 int simcall_comm_testany(xbt_dynar_t comms)
792 {
793   if (xbt_dynar_is_empty(comms))
794     return -1;
795   return simcall_BODY_comm_testany(comms);
796 }
797
798 /**
799  * \ingroup simix_comm_management
800  */
801 void simcall_comm_wait(smx_action_t comm, double timeout)
802 {
803   xbt_assert(isfinite(timeout), "timeout is not finite!");
804   simcall_BODY_comm_wait(comm, timeout);
805 }
806
807 #ifdef HAVE_TRACING
808 /**
809  * \brief Set the category of an action.
810  *
811  * This functions changes the category only. It calls a surf function.
812  * \param execution The execution action
813  * \param category The tracing category
814  */
815 void simcall_set_category(smx_action_t action, const char *category)
816 {
817   if (category == NULL) {
818     return;
819   }
820   simcall_BODY_set_category(action, category);
821 }
822 #endif
823
824 /**
825  * \ingroup simix_comm_management
826  *
827  */
828 int simcall_comm_test(smx_action_t comm)
829 {
830   return simcall_BODY_comm_test(comm);
831 }
832
833 /**
834  * \ingroup simix_comm_management
835  *
836  */
837 double simcall_comm_get_remains(smx_action_t comm)
838 {
839   return simcall_BODY_comm_get_remains(comm);
840 }
841
842 /**
843  * \ingroup simix_comm_management
844  *
845  */
846 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
847 {
848   return simcall_BODY_comm_get_state(comm);
849 }
850
851 /**
852  * \ingroup simix_comm_management
853  *
854  */
855 void *simcall_comm_get_src_data(smx_action_t comm)
856 {
857   return simcall_BODY_comm_get_src_data(comm);
858 }
859
860 /**
861  * \ingroup simix_comm_management
862  *
863  */
864 void *simcall_comm_get_dst_data(smx_action_t comm)
865 {
866   return simcall_BODY_comm_get_dst_data(comm);
867 }
868
869 /**
870  * \ingroup simix_comm_management
871  *
872  */
873 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
874 {
875   return simcall_BODY_comm_get_src_proc(comm);
876 }
877
878 /**
879  * \ingroup simix_comm_management
880  *
881  */
882 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
883 {
884   return simcall_BODY_comm_get_dst_proc(comm);  
885 }
886
887 #ifdef HAVE_LATENCY_BOUND_TRACKING
888 int simcall_comm_is_latency_bounded(smx_action_t comm)
889 {
890   return simcall_BODY_comm_is_latency_bounded(comm);
891 }
892 #endif
893
894 /**
895  * \ingroup simix_synchro_management
896  *
897  */
898 smx_mutex_t simcall_mutex_init(void)
899 {
900   if(!simix_global) {
901     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
902     xbt_abort();
903   }
904   return simcall_BODY_mutex_init();
905 }
906
907 /**
908  * \ingroup simix_synchro_management
909  *
910  */
911 void simcall_mutex_destroy(smx_mutex_t mutex)
912 {
913   simcall_BODY_mutex_destroy(mutex);
914 }
915
916 /**
917  * \ingroup simix_synchro_management
918  *
919  */
920 void simcall_mutex_lock(smx_mutex_t mutex)
921 {
922   simcall_BODY_mutex_lock(mutex);  
923 }
924
925 /**
926  * \ingroup simix_synchro_management
927  *
928  */
929 int simcall_mutex_trylock(smx_mutex_t mutex)
930 {
931   return simcall_BODY_mutex_trylock(mutex);  
932 }
933
934 /**
935  * \ingroup simix_synchro_management
936  *
937  */
938 void simcall_mutex_unlock(smx_mutex_t mutex)
939 {
940   simcall_BODY_mutex_unlock(mutex); 
941 }
942
943 /**
944  * \ingroup simix_synchro_management
945  *
946  */
947 smx_cond_t simcall_cond_init(void)
948 {
949   return simcall_BODY_cond_init();
950 }
951
952 /**
953  * \ingroup simix_synchro_management
954  *
955  */
956 void simcall_cond_destroy(smx_cond_t cond)
957 {
958   simcall_BODY_cond_destroy(cond);
959 }
960
961 /**
962  * \ingroup simix_synchro_management
963  *
964  */
965 void simcall_cond_signal(smx_cond_t cond)
966 {
967   simcall_BODY_cond_signal(cond);
968 }
969
970 /**
971  * \ingroup simix_synchro_management
972  *
973  */
974 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
975 {
976   simcall_BODY_cond_wait(cond, mutex);
977 }
978
979 /**
980  * \ingroup simix_synchro_management
981  *
982  */
983 void simcall_cond_wait_timeout(smx_cond_t cond,
984                                  smx_mutex_t mutex,
985                                  double timeout)
986 {
987   xbt_assert(isfinite(timeout), "timeout is not finite!");
988   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
989 }
990
991 /**
992  * \ingroup simix_synchro_management
993  *
994  */
995 void simcall_cond_broadcast(smx_cond_t cond)
996 {
997   simcall_BODY_cond_broadcast(cond);
998 }
999
1000 /**
1001  * \ingroup simix_synchro_management
1002  *
1003  */
1004 smx_sem_t simcall_sem_init(int capacity)
1005 {
1006   return simcall_BODY_sem_init(capacity);  
1007 }
1008
1009 /**
1010  * \ingroup simix_synchro_management
1011  *
1012  */
1013 void simcall_sem_destroy(smx_sem_t sem)
1014 {
1015   simcall_sem_destroy(sem);
1016 }
1017
1018 /**
1019  * \ingroup simix_synchro_management
1020  *
1021  */
1022 void simcall_sem_release(smx_sem_t sem)
1023 {
1024   simcall_BODY_sem_release(sem);  
1025 }
1026
1027 /**
1028  * \ingroup simix_synchro_management
1029  *
1030  */
1031 int simcall_sem_would_block(smx_sem_t sem)
1032 {
1033   return simcall_BODY_sem_would_block(sem);
1034 }
1035
1036 /**
1037  * \ingroup simix_synchro_management
1038  *
1039  */
1040 void simcall_sem_acquire(smx_sem_t sem)
1041 {
1042   simcall_BODY_sem_acquire(sem);
1043 }
1044
1045 /**
1046  * \ingroup simix_synchro_management
1047  *
1048  */
1049 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1050 {
1051   xbt_assert(isfinite(timeout), "timeout is not finite!");
1052   simcall_BODY_sem_acquire_timeout(sem, timeout);
1053 }
1054
1055 /**
1056  * \ingroup simix_synchro_management
1057  *
1058  */
1059 int simcall_sem_get_capacity(smx_sem_t sem)
1060 {
1061   return simcall_BODY_sem_get_capacity(sem);
1062 }
1063
1064 /**
1065  * \ingroup simix_file_management
1066  *
1067  */
1068 double simcall_file_read(void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1069 {
1070   return simcall_BODY_file_read(ptr, size, nmemb, stream);
1071 }
1072
1073 /**
1074  * \ingroup simix_file_management
1075  *
1076  */
1077 size_t simcall_file_write(const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1078 {
1079   return simcall_BODY_file_write(ptr, size, nmemb, stream);
1080 }
1081
1082 /**
1083  * \ingroup simix_file_management
1084  * \brief
1085  */
1086 smx_file_t simcall_file_open(const char* mount, const char* path, const char* mode)
1087 {
1088   return simcall_BODY_file_open(mount, path, mode);
1089 }
1090
1091 /**
1092  * \ingroup simix_file_management
1093  *
1094  */
1095 int simcall_file_close(smx_file_t fp)
1096 {
1097   return simcall_BODY_file_close(fp);  
1098 }
1099
1100 /**
1101  * \ingroup simix_file_management
1102  *
1103  */
1104 int simcall_file_stat(smx_file_t fd, s_file_stat_t *buf)
1105 {
1106   return simcall_BODY_file_stat(fd, buf);
1107 }
1108
1109 /**
1110  * \ingroup simix_file_management
1111  *
1112  */
1113 int simcall_file_unlink(smx_file_t fd)
1114 {
1115   return simcall_BODY_file_unlink(fd);
1116 }
1117
1118 /**
1119  * \ingroup simix_file_management
1120  *
1121  */
1122 xbt_dict_t simcall_file_ls(const char* mount, const char* path)
1123 {
1124   return simcall_BODY_file_ls(mount, path);
1125 }
1126
1127 #ifdef HAVE_MC
1128
1129 void *simcall_mc_snapshot(void)
1130 {
1131   return simcall_BODY_mc_snapshot();
1132 }
1133
1134 int simcall_mc_compare_snapshots(void *s1, void *s2){ 
1135   return simcall_BODY_mc_compare_snapshots(s1, s2);
1136 }
1137
1138 #endif /* HAVE_MC */
1139
1140 /* ****************************************************************************************** */
1141 /* TUTORIAL: New API                                                                          */
1142 /* All functions for simcall                                                                  */
1143 /* ****************************************************************************************** */
1144 int simcall_new_api_fct(const char* param1, double param2){
1145   smx_simcall_t simcall = SIMIX_simcall_mine();
1146   simcall->call = SIMCALL_NEW_API_INIT;
1147   simcall->new_api.param1 = param1;
1148   simcall->new_api.param2 = param2;
1149
1150   SIMIX_simcall_push(simcall->issuer);
1151   return simcall->new_api.result;
1152 }
1153
1154 /* ************************************************************************** */
1155
1156 /** @brief returns a printable string representing a simcall */
1157 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1158   return simcall_names[kind];
1159 }