Logo AND Algorithmique Numérique Distribuée

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