Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
eb50d4df4c40afc5f6cf79d5863b18a812357811
[simgrid.git] / src / simix / libsmx.c
1 /* libsmx.c - public interface to simix                                       */
2 /* --------                                                                   */
3 /* These functions are the only ones that are visible from the higher levels  */
4 /* (most of them simply add some documentation to the generated simcall body) */
5 /*                                                                            */
6 /* This is somehow the "libc" of SimGrid                                      */
7
8 /* Copyright (c) 2010-2014. The SimGrid Team. All rights reserved.            */
9
10 /* This program is free software; you can redistribute it and/or modify it
11  * under the terms of the license (GNU LGPL) which comes with this package.   */
12
13 #include "smx_private.h"
14 #include "mc/mc_interface.h"
15 #include "xbt/ex.h"
16 #include <math.h>         /* isfinite() */
17
18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
19
20 #include "popping_bodies.c"
21
22 /**
23  * \ingroup simix_host_management
24  * \brief Returns a host given its name.
25  *
26  * \param name The name of the host to get
27  * \return The corresponding host
28  */
29 smx_host_t simcall_host_get_by_name(const char *name)
30 {
31   return simcall_BODY_host_get_by_name(name);
32 }
33
34 /**
35  * \ingroup simix_host_management
36  * \brief Returns the name of a host.
37  *
38  * \param host A SIMIX host
39  * \return The name of this host
40  */
41 const char* simcall_host_get_name(smx_host_t host)
42 {
43   return simcall_BODY_host_get_name(host);
44 }
45
46 /**
47  * \ingroup simix_host_management
48  * \brief Start the host if it is off
49  *
50  * \param host A SIMIX host
51  */
52 void simcall_host_on(smx_host_t host)
53 {
54   simcall_BODY_host_on(host);
55 }
56
57 /**
58  * \ingroup simix_host_management
59  * \brief Stop the host if it is on
60  *
61  * \param host A SIMIX host
62  */
63 void simcall_host_off(smx_host_t host)
64 {
65   simcall_BODY_host_off(host);
66 }
67
68 /**
69  * \ingroup simix_host_management
70  * \brief Returns a dict of the properties assigned to a host.
71  *
72  * \param host A host
73  * \return The properties of this host
74  */
75 xbt_dict_t simcall_host_get_properties(smx_host_t host)
76 {
77   return simcall_BODY_host_get_properties(host);
78 }
79
80 /**
81  * \ingroup simix_host_management
82  * \brief Returns a dict of the properties assigned to a router or AS.
83  *
84  * \param name The name of the router or AS
85  * \return The properties
86  */
87 xbt_dict_t simcall_asr_get_properties(const char *name)
88 {
89   return simcall_BODY_asr_get_properties(name);
90 }
91
92
93 /**
94  * \ingroup simix_host_management
95  * \brief Returns the speed of the processor.
96  *
97  * The speed returned does not take into account the current load on the machine.
98  * \param host A SIMIX host
99  * \return The speed of this host (in Mflop/s)
100  */
101 double simcall_host_get_speed(smx_host_t host)
102 {
103   return simcall_BODY_host_get_speed(host);
104 }
105
106 /**
107  * \ingroup simix_host_management
108  * \brief Returns the number of core of the processor.
109  *
110  * \param host A SIMIX host
111  * \return The number of core
112  */
113 int simcall_host_get_core(smx_host_t host)
114 {
115   return simcall_BODY_host_get_core(host);
116 }
117
118 /**
119  * \ingroup simix_host_management
120  * \brief Returns the list of processes attached to the host.
121  *
122  * \param host A SIMIX host
123  * \return the swag of attached processes
124  */
125 xbt_swag_t simcall_host_get_process_list(smx_host_t host)
126 {
127   return simcall_BODY_host_get_process_list(host);
128 }
129
130
131 /**
132  * \ingroup simix_host_management
133  * \brief Returns the available speed of the processor.
134  *
135  * \return Speed currently available (in Mflop/s)
136  */
137 double simcall_host_get_available_speed(smx_host_t host)
138 {
139   return simcall_BODY_host_get_available_speed(host);
140 }
141
142 /**
143  * \ingroup simix_host_management
144  * \brief Returns the state of a host.
145  *
146  * Two states are possible: 1 if the host is active or 0 if it has crashed.
147  * \param host A SIMIX host
148  * \return 1 if the host is available, 0 otherwise
149  */
150 int simcall_host_get_state(smx_host_t host)
151 {
152   return simcall_BODY_host_get_state(host);
153 }
154
155 /**
156  * \ingroup simix_host_management
157  * \brief Returns the power peak of a host.
158  *
159  * \param host A SIMIX host
160  * \return the current power peak value (double)
161  */
162 double simcall_host_get_current_power_peak(smx_host_t host)
163 {
164   return simcall_BODY_host_get_current_power_peak(host);
165 }
166
167 /**
168  * \ingroup simix_host_management
169  * \brief Returns one power peak (in flops/s) of a host at a given pstate
170  *
171  * \param host A SIMIX host
172  * \param pstate_index pstate to test
173  * \return the current power peak value (double) for pstate_index
174  */
175 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
176 {
177   return simcall_BODY_host_get_power_peak_at(host, pstate_index);
178 }
179
180 /**
181  * \ingroup simix_host_management
182  * \brief Returns the number of power states for a host.
183  *
184  * \param host A SIMIX host
185  * \return the number of power states
186  */
187 int simcall_host_get_nb_pstates(smx_host_t host)
188 {
189   return simcall_BODY_host_get_nb_pstates(host);
190 }
191
192 /**
193  * \ingroup simix_host_management
194  * \brief Sets a new power peak for a host.
195  *
196  * \param host A SIMIX host
197  * \param pstate_index The pstate to which the CPU power will be set
198  */
199 void simcall_host_set_power_peak_at(smx_host_t host, int pstate_index)
200 {
201         simcall_BODY_host_set_power_peak_at(host, pstate_index);
202 }
203
204 /**
205  * \ingroup simix_host_management
206  * \brief Returns the total energy consumed by the host (in Joules)
207  *
208  * \param host A SIMIX host
209  * \return the energy consumed by the host (double)
210  */
211 double simcall_host_get_consumed_energy(smx_host_t host)
212 {
213   return simcall_BODY_host_get_consumed_energy(host);
214 }
215
216
217 /**
218  * \ingroup simix_host_management
219  * \brief Creates a synchro that executes some computation of an host.
220  *
221  * This function creates a SURF action and allocates the data necessary
222  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
223  *
224  * \param name Name of the execution synchro to create
225  * \param host SIMIX host where the synchro will be executed
226  * \param computation_amount amount Computation amount (in bytes)
227  * \param priority computation priority
228  * \param bound
229  * \param affinity_mask
230  * \return A new SIMIX execution synchronization
231  */
232 smx_synchro_t simcall_host_execute(const char *name, smx_host_t host,
233                                     double computation_amount,
234                                     double priority, double bound, unsigned long affinity_mask)
235 {
236   /* checking for infinite values */
237   xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
238   xbt_assert(isfinite(priority), "priority is not finite!");
239
240   return simcall_BODY_host_execute(name, host, computation_amount, priority, bound, affinity_mask);
241 }
242
243 /**
244  * \ingroup simix_host_management
245  * \brief Creates a synchro that may involve parallel computation on
246  * several hosts and communication between them.
247  *
248  * \param name Name of the execution synchro to create
249  * \param host_nb Number of hosts where the synchro will be executed
250  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
251  * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
252  * \param communication_amount Array (of size host_nb * host_nb) representing the communication
253  * amount between each pair of hosts
254  * \param amount the SURF action amount
255  * \param rate the SURF action rate
256  * \return A new SIMIX execution synchronization
257  */
258 smx_synchro_t simcall_host_parallel_execute(const char *name,
259                                          int host_nb,
260                                          smx_host_t *host_list,
261                                          double *computation_amount,
262                                          double *communication_amount,
263                                          double amount,
264                                          double rate)
265 {
266   int i,j;
267   /* checking for infinite values */
268   for (i = 0 ; i < host_nb ; ++i) {
269      xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
270      for (j = 0 ; j < host_nb ; ++j) {
271         xbt_assert(isfinite(communication_amount[i + host_nb * j]),
272              "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
273      }
274   }
275
276   xbt_assert(isfinite(amount), "amount is not finite!");
277   xbt_assert(isfinite(rate), "rate is not finite!");
278
279   return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
280                                             computation_amount,
281                                             communication_amount,
282                                             amount, rate);
283
284 }
285
286 /**
287  * \ingroup simix_host_management
288  * \brief Destroys an execution synchro.
289  *
290  * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
291  * \param execution The execution synchro to destroy
292  */
293 void simcall_host_execution_destroy(smx_synchro_t execution)
294 {
295   simcall_BODY_host_execution_destroy(execution);
296 }
297
298 /**
299  * \ingroup simix_host_management
300  * \brief Cancels an execution synchro.
301  *
302  * This functions stops the execution. It calls a surf function.
303  * \param execution The execution synchro to cancel
304  */
305 void simcall_host_execution_cancel(smx_synchro_t execution)
306 {
307   simcall_BODY_host_execution_cancel(execution);
308 }
309
310 /**
311  * \ingroup simix_host_management
312  * \brief Returns how much of an execution synchro remains to be done.
313  *
314  * \param execution The execution synchro
315  * \return The remaining amount
316  */
317 double simcall_host_execution_get_remains(smx_synchro_t execution)
318 {
319   return simcall_BODY_host_execution_get_remains(execution);
320 }
321
322 /**
323  * \ingroup simix_host_management
324  * \brief Returns the state of an execution synchro.
325  *
326  * \param execution The execution synchro
327  * \return The state
328  */
329 e_smx_state_t simcall_host_execution_get_state(smx_synchro_t execution)
330 {
331   return simcall_BODY_host_execution_get_state(execution);
332 }
333
334 /**
335  * \ingroup simix_host_management
336  * \brief Changes the priority of an execution synchro.
337  *
338  * This functions changes the priority only. It calls a surf function.
339  * \param execution The execution synchro
340  * \param priority The new priority
341  */
342 void simcall_host_execution_set_priority(smx_synchro_t execution, double priority)
343 {
344   /* checking for infinite values */
345   xbt_assert(isfinite(priority), "priority is not finite!");
346
347   simcall_BODY_host_execution_set_priority(execution, priority);
348 }
349
350 /**
351  * \ingroup simix_host_management
352  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
353  *
354  * This functions changes the capping only. It calls a surf function.
355  * \param execution The execution synchro
356  * \param bound The new bound
357  */
358 void simcall_host_execution_set_bound(smx_synchro_t execution, double bound)
359 {
360   simcall_BODY_host_execution_set_bound(execution, bound);
361 }
362
363 /**
364  * \ingroup simix_host_management
365  * \brief Changes the CPU affinity of an execution synchro.
366  *
367  * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
368  * \param execution The execution synchro
369  * \param host Host
370  * \param mask Affinity mask
371  */
372 void simcall_host_execution_set_affinity(smx_synchro_t execution, smx_host_t host, unsigned long mask)
373 {
374   simcall_BODY_host_execution_set_affinity(execution, host, mask);
375 }
376
377 /**
378  * \ingroup simix_host_management
379  * \brief Waits for the completion of an execution synchro and destroy it.
380  *
381  * \param execution The execution synchro
382  */
383 e_smx_state_t simcall_host_execution_wait(smx_synchro_t execution)
384 {
385   return simcall_BODY_host_execution_wait(execution);
386 }
387
388
389 /**
390  * \ingroup simix_vm_management
391  * \brief Create a VM on the given physical host.
392  *
393  * \param name VM name
394  * \param host Physical host
395  *
396  * \return The host object of the VM
397  */
398 void* simcall_vm_create(const char *name, smx_host_t phys_host){
399   return simcall_BODY_vm_create(name, phys_host);
400 }
401
402 /**
403  * \ingroup simix_vm_management
404  * \brief Start the given VM to the given physical host
405  *
406  * \param vm VM
407  */
408 void simcall_vm_start(smx_host_t vm)
409 {
410   simcall_BODY_vm_start(vm);
411 }
412
413 /**
414  * \ingroup simix_vm_management
415  * \brief Get the state of the given VM
416  *
417  * \param vm VM
418  * \return The state of the VM
419  */
420 int simcall_vm_get_state(smx_host_t vm)
421 {
422   return simcall_BODY_vm_get_state(vm);
423 }
424
425 /**
426  * \ingroup simix_vm_management
427  * \brief Get the name of the physical host on which the given VM runs.
428  *
429  * \param vm VM
430  * \return The name of the physical host
431  */
432 void *simcall_vm_get_pm(smx_host_t vm)
433 {
434   return simcall_BODY_vm_get_pm(vm);
435 }
436
437 void simcall_vm_set_bound(smx_host_t vm, double bound)
438 {
439   simcall_BODY_vm_set_bound(vm, bound);
440 }
441
442 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
443 {
444   simcall_BODY_vm_set_affinity(vm, pm, mask);
445 }
446
447 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
448 {
449   simcall_BODY_host_get_params(vm, params);
450 }
451
452 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
453 {
454   simcall_BODY_host_set_params(vm, params);
455 }
456
457 /**
458  * \ingroup simix_vm_management
459  * \brief Migrate the given VM to the given physical host
460  *
461  * \param vm VM
462  * \param host Destination physical host
463  */
464 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
465 {
466   simcall_BODY_vm_migrate(vm, host);
467 }
468
469 /**
470  * \ingroup simix_vm_management
471  * \brief Suspend the given VM
472  *
473  * \param vm VM
474  */
475 void simcall_vm_suspend(smx_host_t vm)
476 {
477   simcall_BODY_vm_suspend(vm);
478 }
479
480 /**
481  * \ingroup simix_vm_management
482  * \brief Resume the given VM
483  *
484  * \param vm VM
485  */
486 void simcall_vm_resume(smx_host_t vm)
487 {
488   simcall_BODY_vm_resume(vm);
489 }
490
491 /**
492  * \ingroup simix_vm_management
493  * \brief Save the given VM
494  *
495  * \param vm VM
496  */
497 void simcall_vm_save(smx_host_t vm)
498 {
499   simcall_BODY_vm_save(vm);
500 }
501
502 /**
503  * \ingroup simix_vm_management
504  * \brief Restore the given VM
505  *
506  * \param vm VM
507  */
508 void simcall_vm_restore(smx_host_t vm)
509 {
510   simcall_BODY_vm_restore(vm);
511 }
512
513 /**
514  * \ingroup simix_vm_management
515  * \brief Shutdown the given VM
516  *
517  * \param vm VM
518  */
519 void simcall_vm_shutdown(smx_host_t vm)
520 {
521   simcall_BODY_vm_shutdown(vm);
522 }
523
524 /**
525  * \ingroup simix_vm_management
526  * \brief Destroy the given VM
527  *
528  * \param vm VM
529  */
530 void simcall_vm_destroy(smx_host_t vm)
531 {
532   simcall_BODY_vm_destroy(vm);
533 }
534
535
536 /**
537  * \ingroup simix_process_management
538  * \brief Creates and runs a new SIMIX process.
539  *
540  * The structure and the corresponding thread are created and put in the list of ready processes.
541  *
542  * \param process the process created will be stored in this pointer
543  * \param name a name for the process. It is for user-level information and can be NULL.
544  * \param code the main function of the process
545  * \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.
546  * It can be retrieved with the function \ref simcall_process_get_data.
547  * \param hostname name of the host where the new agent is executed.
548  * \param kill_time time when the process is killed
549  * \param argc first argument passed to \a code
550  * \param argv second argument passed to \a code
551  * \param properties the properties of the process
552  * \param auto_restart either it is autorestarting or not.
553  */
554 void simcall_process_create(smx_process_t *process, const char *name,
555                               xbt_main_func_t code,
556                               void *data,
557                               const char *hostname,
558                               double kill_time,
559                               int argc, char **argv,
560                               xbt_dict_t properties,
561                               int auto_restart)
562 {
563   simcall_BODY_process_create(process, name, code, data, hostname,
564                               kill_time, argc, argv, properties,
565                               auto_restart);
566 }
567
568 /**
569  * \ingroup simix_process_management
570  * \brief Kills a SIMIX process.
571  *
572  * This function simply kills a  process.
573  *
574  * \param process poor victim
575  */
576 void simcall_process_kill(smx_process_t process)
577 {
578   simcall_BODY_process_kill(process);
579 }
580
581 /**
582  * \ingroup simix_process_management
583  * \brief Kills all SIMIX processes.
584  */
585 void simcall_process_killall(int reset_pid)
586 {
587   simcall_BODY_process_killall(reset_pid);
588 }
589
590 /**
591  * \ingroup simix_process_management
592  * \brief Cleans up a SIMIX process.
593  * \param process poor victim (must have already been killed)
594  */
595 void simcall_process_cleanup(smx_process_t process)
596 {
597   simcall_BODY_process_cleanup(process);
598 }
599
600 /**
601  * \ingroup simix_process_management
602  * \brief Migrates an agent to another location.
603  *
604  * This function changes the value of the host on which \a process is running.
605  *
606  * \param process the process to migrate
607  * \param dest name of the new host
608  */
609 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
610 {
611   simcall_BODY_process_change_host(process, dest);
612 }
613
614 void simcall_process_join(smx_process_t process, double timeout)
615 {
616   simcall_BODY_process_join(process, timeout);
617 }
618
619 /**
620  * \ingroup simix_process_management
621  * \brief Suspends a process.
622  *
623  * This function suspends the process by suspending the synchro
624  * it was waiting for completion.
625  *
626  * \param process a SIMIX process
627  */
628 void simcall_process_suspend(smx_process_t process)
629 {
630   xbt_assert(process, "Invalid parameters");
631
632   simcall_BODY_process_suspend(process);
633 }
634
635 /**
636  * \ingroup simix_process_management
637  * \brief Resumes a suspended process.
638  *
639  * This function resumes a suspended process by resuming the synchro
640  * it was waiting for completion.
641  *
642  * \param process a SIMIX process
643  */
644 void simcall_process_resume(smx_process_t process)
645 {
646   simcall_BODY_process_resume(process);
647 }
648
649 /**
650  * \ingroup simix_process_management
651  * \brief Returns the amount of SIMIX processes in the system
652  *
653  * Maestro internal process is not counted, only user code processes are
654  */
655 int simcall_process_count(void)
656 {
657   return simcall_BODY_process_count();
658 }
659
660 /**
661  * \ingroup simix_process_management
662  * \brief Return the PID of a #smx_process_t.
663  * \param process a SIMIX process
664  * \return the PID of this process
665  */
666 int simcall_process_get_PID(smx_process_t process)
667 {
668   if (process == SIMIX_process_self()) {
669     /* avoid a simcall if this function is called by the process itself */
670     return SIMIX_process_get_PID(process);
671   }
672
673   return simcall_BODY_process_get_PID(process);
674 }
675
676 /**
677  * \ingroup simix_process_management
678  * \brief Return the parent PID of a #smx_process_t.
679  * \param process a SIMIX process
680  * \return the PID of this process parenrt
681  */
682 int simcall_process_get_PPID(smx_process_t process)
683 {
684   if (process == SIMIX_process_self()) {
685     /* avoid a simcall if this function is called by the process itself */
686     return SIMIX_process_get_PPID(process);
687   }
688
689   return simcall_BODY_process_get_PPID(process);
690 }
691
692 /**
693  * \ingroup simix_process_management
694  * \brief Return the user data of a #smx_process_t.
695  * \param process a SIMIX process
696  * \return the user data of this process
697  */
698 void* simcall_process_get_data(smx_process_t process)
699 {
700   if (process == SIMIX_process_self()) {
701     /* avoid a simcall if this function is called by the process itself */
702     return SIMIX_process_get_data(process);
703   }
704
705   return simcall_BODY_process_get_data(process);
706 }
707
708 /**
709  * \ingroup simix_process_management
710  * \brief Set the user data of a #smx_process_t.
711  *
712  * This functions sets the user data associated to \a process.
713  * \param process SIMIX process
714  * \param data User data
715  */
716 void simcall_process_set_data(smx_process_t process, void *data)
717 {
718   if (process == SIMIX_process_self()) {
719     /* avoid a simcall if this function is called by the process itself */
720     SIMIX_process_self_set_data(process, data);
721   }
722   else {
723     simcall_BODY_process_set_data(process, data);
724   }
725 }
726
727 /**
728  * \ingroup simix_process_management
729  * \brief Set the kill time of a process.
730  * \param process a process
731  * \param kill_time a double
732  */
733 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
734 {
735
736   if (kill_time > SIMIX_get_clock()) {
737     if (simix_global->kill_process_function) {
738       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
739           sg_host_name(process->smx_host));
740       SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
741     }
742   }
743 }
744
745 /**
746  * \ingroup simix_process_management
747  * \brief Return the location on which an agent is running.
748  *
749  * This functions returns the smx_host_t corresponding to the location on which
750  * \a process is running.
751  * \param process SIMIX process
752  * \return SIMIX host
753  */
754 smx_host_t simcall_process_get_host(smx_process_t process)
755 {
756   return simcall_BODY_process_get_host(process);
757 }
758
759 /**
760  * \ingroup simix_process_management
761  * \brief Return the name of an agent.
762  *
763  * This functions checks whether \a process is a valid pointer or not and return its name.
764  * \param process SIMIX process
765  * \return The process name
766  */
767 const char* simcall_process_get_name(smx_process_t process)
768 {
769   if (process == SIMIX_process_self()) {
770     /* avoid a simcall if this function is called by the process itself */
771     return process->name;
772   }
773   return simcall_BODY_process_get_name(process);
774 }
775
776 /**
777  * \ingroup simix_process_management
778  * \brief Returns true if the process is suspended .
779  *
780  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
781  * \param process SIMIX process
782  * \return 1, if the process is suspended, else 0.
783  */
784 int simcall_process_is_suspended(smx_process_t process)
785 {
786   return  simcall_BODY_process_is_suspended(process);
787 }
788
789 /**
790  * \ingroup simix_process_management
791  * \brief Return the properties
792  *
793  * This functions returns the properties associated with this process
794  */
795 xbt_dict_t simcall_process_get_properties(smx_process_t process)
796 {
797   return simcall_BODY_process_get_properties(process);
798 }
799 /**
800  * \ingroup simix_process_management
801  * \brief Add an on_exit function
802  * Add an on_exit function which will be executed when the process exits/is killed.
803  */
804 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
805 {
806   simcall_BODY_process_on_exit(process, fun, data);
807 }
808 /**
809  * \ingroup simix_process_management
810  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
811  * Will restart the process when the host comes back up if auto_restart is set to 1.
812  */
813
814 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
815 {
816   simcall_BODY_process_auto_restart_set(process, auto_restart);
817 }
818
819 /**
820  * \ingroup simix_process_management
821  * \brief Restarts the process, killing it and starting it again from scratch.
822  */
823 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
824 {
825   return simcall_BODY_process_restart(process);
826 }
827 /**
828  * \ingroup simix_process_management
829  * \brief Creates a new sleep SIMIX synchro.
830  *
831  * This function creates a SURF action and allocates the data necessary
832  * to create the SIMIX synchro. It can raise a host_error exception if the
833  * host crashed. The default SIMIX name of the synchro is "sleep".
834  *
835  *   \param duration Time duration of the sleep.
836  *   \return A result telling whether the sleep was successful
837  */
838 e_smx_state_t simcall_process_sleep(double duration)
839 {
840   /* checking for infinite values */
841   xbt_assert(isfinite(duration), "duration is not finite!");
842   return simcall_BODY_process_sleep(duration);
843 }
844
845 /**
846  *  \ingroup simix_rdv_management
847  *  \brief Creates a new rendez-vous point
848  *  \param name The name of the rendez-vous point
849  *  \return The created rendez-vous point
850  */
851 smx_rdv_t simcall_rdv_create(const char *name)
852 {
853   return simcall_BODY_rdv_create(name);
854 }
855
856
857 /**
858  *  \ingroup simix_rdv_management
859  *  \brief Destroy a rendez-vous point
860  *  \param rdv The rendez-vous point to destroy
861  */
862 void simcall_rdv_destroy(smx_rdv_t rdv)
863 {
864   simcall_BODY_rdv_destroy(rdv);
865 }
866 /**
867  *  \ingroup simix_rdv_management
868  *  \brief Returns a rendez-vous point knowing its name
869  */
870 smx_rdv_t simcall_rdv_get_by_name(const char *name)
871 {
872   xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
873
874   /* FIXME: this is a horrible loss of performance, so we hack it out by
875    * skipping the simcall (for now). It works in parallel, it won't work on
876    * distributed but probably we will change MSG for that. */
877
878   return SIMIX_rdv_get_by_name(name);
879 }
880
881 /**
882  *  \ingroup simix_rdv_management
883  *  \brief Counts the number of communication synchros of a given host pending
884  *         on a rendez-vous point.
885  *  \param rdv The rendez-vous point
886  *  \param host The host to be counted
887  *  \return The number of comm synchros pending in the rdv
888  */
889 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
890 {
891   return simcall_BODY_rdv_comm_count_by_host(rdv, host);
892 }
893
894 /**
895  *  \ingroup simix_rdv_management
896  *  \brief returns the communication at the head of the rendez-vous
897  *  \param rdv The rendez-vous point
898  *  \return The communication or NULL if empty
899  */
900 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
901 {
902   return simcall_BODY_rdv_get_head(rdv);
903 }
904
905 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
906 {
907   simcall_BODY_rdv_set_receiver(rdv, process);
908 }
909
910 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
911 {
912   return simcall_BODY_rdv_get_receiver(rdv);
913 }
914
915 /**
916  * \ingroup simix_comm_management
917  */
918 void simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
919                          void *src_buff, size_t src_buff_size,
920                          int (*match_fun)(void *, void *, smx_synchro_t),
921                          void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
922                          double timeout)
923 {
924   /* checking for infinite values */
925   xbt_assert(isfinite(task_size), "task_size is not finite!");
926   xbt_assert(isfinite(rate), "rate is not finite!");
927   xbt_assert(isfinite(timeout), "timeout is not finite!");
928
929   xbt_assert(rdv, "No rendez-vous point defined for send");
930
931   if (MC_is_active() || MC_record_replay_is_active()) {
932     /* the model-checker wants two separate simcalls */
933     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
934     comm = simcall_comm_isend(src, rdv, task_size, rate,
935         src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
936     simcall_comm_wait(comm, timeout);
937     comm = NULL;
938   }
939   else {
940     simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
941                          match_fun, copy_data_fun, data, timeout);
942   }
943 }
944
945 /**
946  * \ingroup simix_comm_management
947  */
948 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
949                               void *src_buff, size_t src_buff_size,
950                               int (*match_fun)(void *, void *, smx_synchro_t),
951                               void (*clean_fun)(void *),
952                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
953                               void *data,
954                               int detached)
955 {
956   /* checking for infinite values */
957   xbt_assert(isfinite(task_size), "task_size is not finite!");
958   xbt_assert(isfinite(rate), "rate is not finite!");
959
960   xbt_assert(rdv, "No rendez-vous point defined for isend");
961
962   return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
963                                  src_buff_size, match_fun,
964                                  clean_fun, copy_data_fun, data, detached);
965 }
966
967 /**
968  * \ingroup simix_comm_management
969  */
970 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
971                        int (*match_fun)(void *, void *, smx_synchro_t),
972                        void (*copy_data_fun)(smx_synchro_t, void*, size_t),
973                        void *data, double timeout, double rate)
974 {
975   xbt_assert(isfinite(timeout), "timeout is not finite!");
976   xbt_assert(rdv, "No rendez-vous point defined for recv");
977
978   if (MC_is_active() || MC_record_replay_is_active()) {
979     /* the model-checker wants two separate simcalls */
980     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
981     comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
982                               match_fun, copy_data_fun, data, rate);
983     simcall_comm_wait(comm, timeout);
984     comm = NULL;
985   }
986   else {
987     simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
988                            match_fun, copy_data_fun, data, timeout, rate);
989   }
990 }
991 /**
992  * \ingroup simix_comm_management
993  */
994 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
995                                 int (*match_fun)(void *, void *, smx_synchro_t),
996                                 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
997                                 void *data, double rate)
998 {
999   xbt_assert(rdv, "No rendez-vous point defined for irecv");
1000
1001   return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1002                                  match_fun, copy_data_fun, data, rate);
1003 }
1004
1005 /**
1006  * \ingroup simix_comm_management
1007  */
1008 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1009                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1010 {
1011   xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1012
1013   return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1014 }
1015
1016 /**
1017  * \ingroup simix_comm_management
1018  */
1019 void simcall_comm_cancel(smx_synchro_t comm)
1020 {
1021   simcall_BODY_comm_cancel(comm);
1022 }
1023
1024 /**
1025  * \ingroup simix_comm_management
1026  */
1027 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1028 {
1029   return simcall_BODY_comm_waitany(comms);
1030 }
1031
1032 /**
1033  * \ingroup simix_comm_management
1034  */
1035 int simcall_comm_testany(xbt_dynar_t comms)
1036 {
1037   if (xbt_dynar_is_empty(comms))
1038     return -1;
1039   return simcall_BODY_comm_testany(comms);
1040 }
1041
1042 /**
1043  * \ingroup simix_comm_management
1044  */
1045 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1046 {
1047   xbt_assert(isfinite(timeout), "timeout is not finite!");
1048   simcall_BODY_comm_wait(comm, timeout);
1049 }
1050
1051 #ifdef HAVE_TRACING
1052 /**
1053  * \brief Set the category of an synchro.
1054  *
1055  * This functions changes the category only. It calls a surf function.
1056  * \param execution The execution synchro
1057  * \param category The tracing category
1058  */
1059 void simcall_set_category(smx_synchro_t synchro, const char *category)
1060 {
1061   if (category == NULL) {
1062     return;
1063   }
1064   simcall_BODY_set_category(synchro, category);
1065 }
1066 #endif
1067
1068 /**
1069  * \ingroup simix_comm_management
1070  *
1071  */
1072 int simcall_comm_test(smx_synchro_t comm)
1073 {
1074   return simcall_BODY_comm_test(comm);
1075 }
1076
1077 /**
1078  * \ingroup simix_comm_management
1079  *
1080  */
1081 double simcall_comm_get_remains(smx_synchro_t comm)
1082 {
1083   return simcall_BODY_comm_get_remains(comm);
1084 }
1085
1086 /**
1087  * \ingroup simix_comm_management
1088  *
1089  */
1090 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1091 {
1092   return simcall_BODY_comm_get_state(comm);
1093 }
1094
1095 /**
1096  * \ingroup simix_comm_management
1097  *
1098  */
1099 void *simcall_comm_get_src_data(smx_synchro_t comm)
1100 {
1101   return simcall_BODY_comm_get_src_data(comm);
1102 }
1103
1104 /**
1105  * \ingroup simix_comm_management
1106  *
1107  */
1108 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1109 {
1110   return simcall_BODY_comm_get_dst_data(comm);
1111 }
1112
1113 /**
1114  * \ingroup simix_comm_management
1115  *
1116  */
1117 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1118 {
1119   return simcall_BODY_comm_get_src_proc(comm);
1120 }
1121
1122 /**
1123  * \ingroup simix_comm_management
1124  *
1125  */
1126 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1127 {
1128   return simcall_BODY_comm_get_dst_proc(comm);
1129 }
1130
1131 #ifdef HAVE_LATENCY_BOUND_TRACKING
1132 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1133 {
1134   return simcall_BODY_comm_is_latency_bounded(comm);
1135 }
1136 #endif
1137
1138 /**
1139  * \ingroup simix_synchro_management
1140  *
1141  */
1142 smx_mutex_t simcall_mutex_init(void)
1143 {
1144   if(!simix_global) {
1145     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
1146     xbt_abort();
1147   }
1148   return simcall_BODY_mutex_init();
1149 }
1150
1151 /**
1152  * \ingroup simix_synchro_management
1153  *
1154  */
1155 void simcall_mutex_destroy(smx_mutex_t mutex)
1156 {
1157   simcall_BODY_mutex_destroy(mutex);
1158 }
1159
1160 /**
1161  * \ingroup simix_synchro_management
1162  *
1163  */
1164 void simcall_mutex_lock(smx_mutex_t mutex)
1165 {
1166   simcall_BODY_mutex_lock(mutex);
1167 }
1168
1169 /**
1170  * \ingroup simix_synchro_management
1171  *
1172  */
1173 int simcall_mutex_trylock(smx_mutex_t mutex)
1174 {
1175   return simcall_BODY_mutex_trylock(mutex);
1176 }
1177
1178 /**
1179  * \ingroup simix_synchro_management
1180  *
1181  */
1182 void simcall_mutex_unlock(smx_mutex_t mutex)
1183 {
1184   simcall_BODY_mutex_unlock(mutex);
1185 }
1186
1187 /**
1188  * \ingroup simix_synchro_management
1189  *
1190  */
1191 smx_cond_t simcall_cond_init(void)
1192 {
1193   return simcall_BODY_cond_init();
1194 }
1195
1196 /**
1197  * \ingroup simix_synchro_management
1198  *
1199  */
1200 void simcall_cond_destroy(smx_cond_t cond)
1201 {
1202   simcall_BODY_cond_destroy(cond);
1203 }
1204
1205 /**
1206  * \ingroup simix_synchro_management
1207  *
1208  */
1209 void simcall_cond_signal(smx_cond_t cond)
1210 {
1211   simcall_BODY_cond_signal(cond);
1212 }
1213
1214 /**
1215  * \ingroup simix_synchro_management
1216  *
1217  */
1218 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1219 {
1220   simcall_BODY_cond_wait(cond, mutex);
1221 }
1222
1223 /**
1224  * \ingroup simix_synchro_management
1225  *
1226  */
1227 void simcall_cond_wait_timeout(smx_cond_t cond,
1228                                  smx_mutex_t mutex,
1229                                  double timeout)
1230 {
1231   xbt_assert(isfinite(timeout), "timeout is not finite!");
1232   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1233 }
1234
1235 /**
1236  * \ingroup simix_synchro_management
1237  *
1238  */
1239 void simcall_cond_broadcast(smx_cond_t cond)
1240 {
1241   simcall_BODY_cond_broadcast(cond);
1242 }
1243
1244 /**
1245  * \ingroup simix_synchro_management
1246  *
1247  */
1248 smx_sem_t simcall_sem_init(int capacity)
1249 {
1250   return simcall_BODY_sem_init(capacity);
1251 }
1252
1253 /**
1254  * \ingroup simix_synchro_management
1255  *
1256  */
1257 void simcall_sem_destroy(smx_sem_t sem)
1258 {
1259   simcall_BODY_sem_destroy(sem);
1260 }
1261
1262 /**
1263  * \ingroup simix_synchro_management
1264  *
1265  */
1266 void simcall_sem_release(smx_sem_t sem)
1267 {
1268   simcall_BODY_sem_release(sem);
1269 }
1270
1271 /**
1272  * \ingroup simix_synchro_management
1273  *
1274  */
1275 int simcall_sem_would_block(smx_sem_t sem)
1276 {
1277   return simcall_BODY_sem_would_block(sem);
1278 }
1279
1280 /**
1281  * \ingroup simix_synchro_management
1282  *
1283  */
1284 void simcall_sem_acquire(smx_sem_t sem)
1285 {
1286   simcall_BODY_sem_acquire(sem);
1287 }
1288
1289 /**
1290  * \ingroup simix_synchro_management
1291  *
1292  */
1293 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1294 {
1295   xbt_assert(isfinite(timeout), "timeout is not finite!");
1296   simcall_BODY_sem_acquire_timeout(sem, timeout);
1297 }
1298
1299 /**
1300  * \ingroup simix_synchro_management
1301  *
1302  */
1303 int simcall_sem_get_capacity(smx_sem_t sem)
1304 {
1305   return simcall_BODY_sem_get_capacity(sem);
1306 }
1307
1308 /**
1309  * \ingroup simix_file_management
1310  *
1311  */
1312 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, smx_host_t host)
1313 {
1314   return simcall_BODY_file_read(fd, size, host);
1315 }
1316
1317 /**
1318  * \ingroup simix_file_management
1319  *
1320  */
1321 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, smx_host_t host)
1322 {
1323   return simcall_BODY_file_write(fd, size, host);
1324 }
1325
1326 /**
1327  * \ingroup simix_file_management
1328  * \brief
1329  */
1330 smx_file_t simcall_file_open(const char* fullpath, smx_host_t host)
1331 {
1332   return simcall_BODY_file_open(fullpath, host);
1333 }
1334
1335 /**
1336  * \ingroup simix_file_management
1337  *
1338  */
1339 int simcall_file_close(smx_file_t fd, smx_host_t host)
1340 {
1341   return simcall_BODY_file_close(fd, host);
1342 }
1343
1344 /**
1345  * \ingroup simix_file_management
1346  *
1347  */
1348 int simcall_file_unlink(smx_file_t fd, smx_host_t host)
1349 {
1350   return simcall_BODY_file_unlink(fd, host);
1351 }
1352
1353 /**
1354  * \ingroup simix_file_management
1355  *
1356  */
1357 sg_size_t simcall_file_get_size(smx_file_t fd){
1358   return simcall_BODY_file_get_size(fd);
1359 }
1360
1361 /**
1362  * \ingroup simix_file_management
1363  *
1364  */
1365 sg_size_t simcall_file_tell(smx_file_t fd){
1366   return simcall_BODY_file_tell(fd);
1367 }
1368
1369 /**
1370  * \ingroup simix_file_management
1371  *
1372  */
1373 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1374 {
1375   return simcall_BODY_file_get_info(fd);
1376 }
1377
1378 /**
1379  * \ingroup simix_file_management
1380  *
1381  */
1382 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1383   return simcall_BODY_file_seek(fd, offset, origin);
1384 }
1385
1386 /**
1387  * \ingroup simix_file_management
1388  * \brief Move a file to another location on the *same mount point*.
1389  *
1390  */
1391 int simcall_file_move(smx_file_t fd, const char* fullpath)
1392 {
1393   return simcall_BODY_file_move(fd, fullpath);
1394 }
1395
1396 /**
1397  * \ingroup simix_storage_management
1398  * \brief Returns the free space size on a given storage element.
1399  * \param storage a storage
1400  * \return Return the free space size on a given storage element (as sg_size_t)
1401  */
1402 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1403   return simcall_BODY_storage_get_free_size(storage);
1404 }
1405
1406 /**
1407  * \ingroup simix_storage_management
1408  * \brief Returns the used space size on a given storage element.
1409  * \param storage a storage
1410  * \return Return the used space size on a given storage element (as sg_size_t)
1411  */
1412 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1413   return simcall_BODY_storage_get_used_size(storage);
1414 }
1415
1416 /**
1417  * \ingroup simix_storage_management
1418  * \brief Returns the list of storages mounted on an host.
1419  * \param host A SIMIX host
1420  * \return a dict containing all storages mounted on the host
1421  */
1422 xbt_dict_t simcall_host_get_mounted_storage_list(smx_host_t host)
1423 {
1424   return simcall_BODY_host_get_mounted_storage_list(host);
1425 }
1426
1427 /**
1428  * \ingroup simix_storage_management
1429  * \brief Returns the list of storages attached to an host.
1430  * \param host A SIMIX host
1431  * \return a dict containing all storages attached to the host
1432  */
1433 xbt_dynar_t simcall_host_get_attached_storage_list(smx_host_t host)
1434 {
1435   return simcall_BODY_host_get_attached_storage_list(host);
1436 }
1437
1438 /**
1439  * \ingroup simix_storage_management
1440  * \brief Returns a dict of the properties assigned to a storage element.
1441  *
1442  * \param storage A storage element
1443  * \return The properties of this storage element
1444  */
1445 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1446 {
1447   return simcall_BODY_storage_get_properties(storage);
1448 }
1449
1450 /**
1451  * \ingroup simix_storage_management
1452  * \brief Returns a dict containing the content of a storage element.
1453  *
1454  * \param storage A storage element
1455  * \return The content of this storage element as a dict (full path file => size)
1456  */
1457 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1458 {
1459   return simcall_BODY_storage_get_content(storage);
1460 }
1461
1462
1463
1464 #ifdef HAVE_MC
1465
1466 void *simcall_mc_snapshot(void) {
1467   return simcall_BODY_mc_snapshot();
1468 }
1469
1470 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1471   return simcall_BODY_mc_compare_snapshots(s1, s2);
1472 }
1473
1474 #endif /* HAVE_MC */
1475
1476 int simcall_mc_random(int min, int max) {
1477   return simcall_BODY_mc_random(min, max);
1478 }
1479
1480 /* ************************************************************************** */
1481
1482 /** @brief returns a printable string representing a simcall */
1483 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1484   return simcall_names[kind];
1485 }